Standard Structure

All webhook events will follow this standard format.

When you receive a webhook event, this is the format that all events will have. Individual event types will have their information under the data property. All events are sent as a POST.

Schema

Name	Type	Description
eventId	string	An Id for the event. You can use this to check if you've already processed a specific event as it's possible for an event to be received more than once if our system attempts a retry. Formatted as a GUID.
eventType	string	The type of event being sent. You server must always handle the TEST_EVENT event to add the webhook.
organisationId	string	The Id of the organisation this event is for. Formatted as a GUID.
sent	string	The date and time this event was sent. Formatted in ISO 8601.
data	object	The data specific to the event type. This will be null for a TEST_EVENT.

Example

{
  "eventId": "00000000-0000-0000-0000-000000000000",
  "eventType": "TEST_EVENT",
  "organisationId": "00000000-0000-0000-0000-000000000000",
  "sent": "2022-09-20T07:53:12.2664878+00:00",
  "data": null
}

sds