SchemaNotificationsEvent Subscriptions

List event subscriptions

Use this method to retrieve a paginated list of event subscriptions that are linked to your ISV account.

Note: If you want to view a specific event subscription and you have its id, use our Retrieve Event Subscription method.

Use query parameters to filter the list of results that we return, for example, to search for subscriptions with a specific status or an event type.

Our gateway returns the following information about each subscription in the list:

  • Event types that you have subscribed to.
  • Whether you have enabled notifications for the subscription.
  • How we contact you when an event occurs, including the endpoint that send notifications to.
  • If there are any issues when we try to send you a notification, for example, if we can’t contact your endpoint.

For each event subscription, we also return its id, which you can use to perform follow-on actions.

Headers

AuthorizationstringRequired

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

Query parameters

statusenumOptional
Filter event subscriptions by subscription status.
Allowed values:
eventstringOptional

Filter event subscriptions by an event type. For a list of event types, go to Events List.

Response

Successful request. Returns a list of event subscriptions.
countdouble or null
Number of results that we returned.
datalist of objects or null
Array of eventSubscription objects.
hasMoreboolean or null
Indicates that further results are available.
limitdouble or null
Maximum number of results that we return for each page.

Errors