Central Dispatch’s Event API allows customers to receive event notifications. It offers a comprehensive list of events along with detailed descriptions, enabling users to subscribe to events of interest. Additionally, the API provides functionality to search and retrieve historical customer events.
🔑 Scope: event_api

📝 Important Notes

• Event Notification does not guarantee order of event delivery, nor does it guarantee a single instance of event delivery. The end partner should support these eventualities. The eventId key in the event payload can be used to identify duplicate event deliveries.
• The subscription response returns an Api-Token header that should be stored by the partner. This token will be sent with every event notification, and the partner should compare the Api-Token sent with each event against their own cached version to validate event authenticity. This is the only authentication that should be implemented for this endpoint.
• Events and status of the events are presisted. If an eventing user is unable to receive events for some time, they can work with the Search Events endpoint.
• The customer must provide an endpoint that CD event notification service can call to push the message.
• The body of the events delivered to the customer’s webhook (supplied through subscription) will vary based on event type that is being delivered.