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:
- Once you have sent the
checkPointfor a page of events they are removed from the queue! - 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!
This feature is in private preview
This feature is in private preview and therefore is subject to change. If you would like to preview this feature please contact your customer representative or our support team
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.
Details of events and their structures can be found here.