List event subscriptions

3 parameters

cursorstringoptional

Returns the page of event subscriptions after this cursor.

limitintegeroptional

Maximum number of subscriptions to return. Must be between 1 and 100. Defaults to 100 when omitted.

Default:100

idempotency_keystringoptional

Filter for the subscription with this idempotency key. Must be between 1 and 200 characters.

3 status codes

200Returns a page of event subscription objects and a `next_cursor` for retrieving the next page.

dataarray<EventSubscription>required

The contents of the list.

next_cursorstringrequired

A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.

4XXReturned when the request has a client-side error.

5XXReturned when the request encounters a server-side error.

Error handling

limit must be between 1 and 100, and idempotency_key must be between 1 and 200 characters when provided.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
});

const result = await client.eventSubscriptions.list({
  cursor: "example",
  limit: 20,
  idempotencyKey: "example",
});

{
  "data": [
    {
      "created_at": "2020-01-31T23:59:59Z",
      "id": "event_subscription_001dzz0r20rcdxgb013zqb8m04g",
      "idempotency_key": null,
      "oauth_connection_id": null,
      "selected_event_categories": null,
      "status": "active",
      "type": "event_subscription",
      "url": "https://website.com/webhooks"
    }
  ],
  "next_cursor": "v57w5d"
}

Request

Response

Errors