Webhook v2 Object Structure
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the object. |
| url | string (unique per workspace) | The URL of the webhook endpoint. |
| description | string (nullable) | A description of the webhook. |
| events | array of strings (enums) | The list of events to enable for this endpoint. ['*'] indicates that all events are enabled. |
| status | string (enum) | The webhook status. It can be enabled or disabled. |
| createdAt | number | Time at which the object was created. Measured in seconds since the Unix epoch. |
| updateAt | number | Time at which the object was updated. Measured in seconds since the Unix epoch. |
Webhook v2 Event Object Structure
This is the structure of data payload sent to your system when an event triggers the webhook.
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the object. |
| eventType | string (enum) | Description of the event (transaction.created). |
| eventVersion | integer | The version of the specific event. |
| resourceId (optional) | UUID | Optional ID of the entity that triggered the event (i.e., txId). |
| data | object | Object containing data associated with the event. |
| createdAt | timestamp | Time at which the object was created and measured in seconds since the Unix epoch. |
| workspaceId | UUID | The workspace ID |