GET
/
v1
/
events
curl --request GET \
  --url https://api.sequin.io/v1/events \
  --header 'Authorization: Bearer <token>'
  [
    "events": [
      {
        "sync_id": "b11f1bf9-4a45-406e-ba77-e06d199e25db",
        "collection_id" : "stripe:subscription",
        "upstream_id": "sub_tognkns00nj",
        "upstream_updated_at": "2024-11-10T18:38:00.070453Z",
        "data": {
          "id": "sub_tognkns00nj",
          "object": "subscription",
          "billing": "charge_automatically",
          // …
        },
        "event": "created",
        "event_id": "cdbf6ba1-97dd-45ee-991d-6c79464cb8a2",
        "event_inserted_at": "2024-11-10T18:38:00.070453Z"
      },
      {
        "sync_id": "5cff68fa-dadb-47ec-a09c-054376cf842b",
        "collection_id" : "salesforce:opportunity",
        "upstream_id": "0060otixltg2",
        "upstream_updated_at": "2024-11-10T18:39:00.090999Z",
        "data": {
          "Id": "0060otixltg2",
          "Name": "Acme - 1,200 Widgets",
          // …
        },
        "event": "updated",
        "event_id": "e2b0f6a1-97dd-45ee-991d-6c79464cb8a2",
        "event_inserted_at": "2024-11-10T18:39:00.090999Z"
      }
    ],
    "cursor": "NjA2"
  ]
This endpoint is not yet publicly available. If you’re interested in using it, please contact us.

​
Request parameters

By default, this endpoint returns all events across all syncs and collections in your account. To filter the events returned, you can send along one or all of the following request parameters:

sync_id
string

Filter for events for this particular sync.

Defaults to all syncs.

provider
string

Filter for events from this provider. Value is the provider’s slug, e.g. stripe. See the list of possible values.

Defaults to all providers.

collection
string

Filter for events for this collection (e.g. Stripe’s stripe:subscription or Salesforce’s salesforce:contact).

Defaults to all collections.

after_cursor
string

Filter for records with a cursor greater than this value. Used to paginate the stream (see Pagination).

Defaults to null, which means the first page of records is returned (the earliest records in the stream).

limit
number

The maximum number of events to return. Can request up to 500 events at a time.

Defaults to 100.

​
Response fields

The response is an object that contains an array of event objects:

events
event[]

An array of event objects.

cursor
string

The cursor you can use to fetch the next page of events.

The cursor will always be returned, even if there are currently no more events to fetch. See Pagination below for more details.

The events in the response are ordered by upstream_updated_at in ascending order (oldest first).

​
Pagination

The response will always contain a cursor field, even if there are no more events to fetch. Simply send back the cursor from the last response to fetch the next page of events.

If you send a cursor and there are no more events to return, the response will contain an empty events array and the same cursor value you sent.

Was this page helpful?

List recordsOverview