Create Subscription

post

{protocol}://{server}/api/notification/v1beta/accounts/{accountId}/subscriptions

Create a new subscription for notification events

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

Body Params

Create a new Subscription

Request payload for creating a subscription

family

string

enum

required

length ≤ 256

The family of events the subscription applies to

Allowed:

events

array of strings

required

length between 1 and 25

The collection of events to filter on within the chosen family. To receive all events associated with a family then specify 'ALL' here. Event types vary depending on family selected, see developers guide for more details on the events for each family.

events*

transport

object

required

Transport settings for the subscription.

extensions

object

Additional extensions based on the family of the subscription. So families may have both manadatory and optional extensions. See the developers guide for more details on the extensions avaialble for each family.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses