GuidesRecipesAPI Reference
API Reference
Select productLog inHelp centre

Create subscription

post
https://{region}-api.dotdigital.com/events/v3/export/subscriptions

📢

Public preview

This feature is in Public preview and should be considered a beta feature. It may be subject to service disruption and short notice changes or improvements.

The name passed must be unique within the account's subscriptions.

More details on the events you can subscribe to can be found here .

If you apply filters to your event subscription then all filters must match (logical AND) for the event to be captured. If you want to match the same event type on multiple different sets of filters (logical OR) then add the event type multiple times to the subscription with differing filters.

Learn more about events and subscriptions


Body Params

Subscription details

string
required
length between 1 and 50
string
enum
required
Defaults to inactive
Allowed:
subscribedEventTypes
array of objects
required
length between 1 and 100
subscribedEventTypes*

string
required
filters
array of objects
length between 1 and 5
filters

string
required
string
required
length between 1 and 1024
boolean
Defaults to true
alertsConfiguration
required
Headers
string
string
length ≤ 60
Defaults to customer
Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated about 1 month ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago