Webhook Events and Payload
Webhook Events and Payload
Webhook Common Properties in the Payload
Each webhook event payload also contains properties unique to the event. You can find the unique properties in the individual event documentation.
| Name | Type | Description |
|---|---|---|
| AggregateId | UUID | The unique identifier of the aggregate (information entity) that the event happended for. |
| OwnerId | UUID | The unique identifier of the owner (tenant) that the event belongs to. |
| EventId | UUID | The unique identifier for the event. Can be used for idempotency, logging and more. |
| Occured | DateTime | The date and time (in UTC) when the event occurred. |
| CausedByPersonId | UUID | The unique identifier of the user that caused the event (if any). |
| CausedBy | string | The name of the user that caused the event (if any). |
| TraceId | string | The trace id that can be used to trace different actions that is going on in a system. |
Delivery Headers
The HTTP POST payloads send to your webhook’s configured URL endpoint will contain the following custom HTTP headers:
| Header | Description |
|---|---|
| X-IRM-Signature | A base64 encoded HMAC-SHA256 signature of the body, signed with your API key (secret). |
| X-IRM-Topic | The topic that you registered for this webhook encoded as base64 (UTF8). |
| X-IRM-EventType | A base64 (UTF8) encoded full name of the event, guaranteed to be unique. |
Also, the User-Agent for the requests will be IRM-Webhook.