Webhook Structure
Last update: 18 minutes ago by Nazar32Reading time: 2 min
All webhooks will arrive as a POST request with a JSON body representing event metadata as well as a data payload specific to each event type The common properties are as follows:
| Field | Type | Description |
|---|---|---|
| messageId | string | The unique identifier for the event message |
| entityId | string | The unique identifier for the record the event is regarding - Typically a UUID, but where entities do not natively have their own UUID a composite key will be provided instead |
| eventRaisedDateTime | string | When the event occurred within the platform - This is represented as an ISO 8601 string |
| eventType | string | The type of event being provided - Used to determine what data will be provided |
| data | object | The data payload, which will vary in structure depending on the eventType |