Sign in
eventSubscriptions

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.

get/event-subscriptions/{subscriptionId}

Path parameters

subscriptionIdinteger required

Unique identifier that we assigned to the event subscription.
Note: Our gateway returned the subscriptionId in the id field in the response of the Create Event Subscription method.

Headers

Authorizationstring required

Bearer authentication

Response

Returns the event subscription object.

idinteger

Unique identifier that we assigned to the event subscription.

enabledboolean required

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.
status'registered' | 'suspended' | 'failed'

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.
eventTypesstring[] required

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

metadataEventSubscriptionMetadata

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.