Retrieve events

Recipes
Retrieving events using the Events API
Open Recipe

📢

Public preview

This feature is in Public preview and should be considered a beta feature. It may be subject to service disruption and short notice changes or improvements.


If you're retrieving events for a subscription for the first time, then do not pass a checkPoint value and the earliest events queued for the subscription are retrieved. On subsequent calls, pass the checkPoint value returned in the previous call to indicate you have received that page of events successfully.

Once you have sent the checkPoint for a page of events they are removed from the queue. If we return no events in the events array then you have received all the currently queued events.

Maximum call duration permitted is 30 seconds.

❗️

You must ensure that you pick up the latest events for a subscription within a 30-day period, otherwise the subscription is automatically set toinactive status due to non-usage.

Your last checkpoint value will become invalid and calls made using it will result in a 400 error with the error code events:checkpointOutOfRange. To start collecting events again simply omit the checkpoint parameter when calling to get the earliest data and a valid checkpoint.


Details of events and their structures can be found here.


Path Params
integer
required
Query Params
integer
1 to 5000
Defaults to 2000
string
Headers
string
Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json