SchemaNotificationsEvent Subscriptions

Retrieve event subscription

Use this method to retrieve the details of an event subscription.

In your request, include the subscriptionId that we sent to you when we created the event subscription.

Note: If you don’t know the subscriptionId of the event subscription, go to List event subscriptions.

Path parameters

subscriptionIdstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Returns the event subscription object.
enabledboolean

Indicates if we should notify you when the event occurs. The value is one of the following:

  • true - We notify you when the event occurs.
  • false - We don’t notify you when the event occurs.
eventTypeslist of strings

Array of events that you want to subscribe to. For a list of events, go to Events List.

notificationslist of objects
Array of notifications objects. Each object contains information about how we contact you when an event occurs.
iddouble or null
Unique identifier that we assigned to the event subscription.
statusenum or null

Status of the subscription. We return one of the following values:

  • registered - You have set up the subscription, and we will notify you when an event occurs.
  • suspended - We have deactivated the event subscription, and we won’t notify you when an event occurs.
  • failed - We couldn’t contact your URI endpoint. We email the supportEmailAddress.
Allowed values:
metadataobject or null

Object that you can send to include custom data in the request. For more information about how to use metadata, go to Metadata.

Errors