Gets a set of events for a events subscription. If starting to retrieve events then do not pass a checkPoint and the earliest events queued for the subscription will be retrieved, and on subsequent calls pass the checkPoint value from the previous call to indicate you have received that page of events successfully.
Note:
- Ensure you pass the returned
checkPointto ensure you only get events after the last time you called. - You must ensure that you pick up the latest events for a subscription within a 30 day period, otherwise the subscription will automatically be set to
inactivestatus due to non usage. - If we return no events in the
eventsarray then you have received all the currently queued events. - Maximum call duration permitted is 30 seconds!
Public previewThis 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 to
inactivestatus due to non-usage.Your last
checkpointvalue will become invalid and calls made using it will result in a 400 error with the error codeevents:checkpointOutOfRange. To start collecting events again simply omit thecheckpointparameter when calling to get the earliest data and a valid checkpoint.
Details of events and their structures can be found here.
Unauthorized
Forbidden
Internal Server Error