Retrieve a Subscription

Request

Returns data about single Subscription.

Security

ApiKeyAuth

Path

subdomainstringrequired

Unique subdomain of requested Hub.

subscription_idintegerrequired

id of the subscription to be deleted

Query

extendstring

Specifies which properties should be expanded.
Expanded properties contains more detailed information which is less frequently needed in typical usage.
Currently supported only for flags.

Example:extend=flags

api_versionstring

Api version

Value:"V3-R1"

curl -i -X GET \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/subscriptions/{subscription_id}?extend=flags&api_version=V3-R1' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

idinteger, >= 1

Example:86

addressstring

Address for a subscription. Exact meaning depends on method name:

email - email address,
sms - phone number,
webhook - URL,
slack - Slack Incoming Webhook URL,
teams - MS Teams Incoming Webhook URL.

Example:"example@statushub.com"

configurationobject

Additional configuration for this method name or this Subscription

Example:

{
  "content_type": "application/json"
}

method_namestring

Enum:"email""sms""webhook""slack""teams"

Example:"email"

subscriber_idinteger, >= 1

Example:87

services_selectionobject

flagsBasic flags (object) or Extended flags (object)

One of:

labelstring or null

Additional information to add better meaning for subscription.
Typically used to add responsible person name or team to SMS or URL-based subscriptions where address alone is not enough to know who is receiving the notifications.
Not available for email subscriptions.

Example:"Responsible person name"

created_atstring, (date-time)

Timestamp of record creation.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"

updated_atstring, (date-time)

Timestamp of last modification of record.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"

Response

{
  "id": 86,
  "address": "example@statushub.com",
  "configuration": {
    "content_type": "application/json"
  },
  "method_name": "email",
  "subscriber_id": 87,
  "services_selection": {
    "all": true,
    "services": [ … ]
  },
  "flags": {
    "deleted": false
  },
  "label": "Responsible person name",
  "created_at": "2020-09-01T08:29:00Z",
  "updated_at": "2020-09-01T08:29:00Z"
}