Webhook Event
This page describes the generic structure of all webhook payloads sent by Minteo.
Payload Structure
All webhooks follow this format:
| Name | Type | Example / Possible values | Description |
|---|---|---|---|
event_id | string | "EVENT#123e4567-e89b-12d3-a456-426614174000" | Unique identifier for the event (prefixed with EVENT#). Use this for deduplication. |
hook_id | string | "HOOK#2f6d8c1b-5f8f-4b3a-9d52-87a6f3bcd8c2" | Unique identifier for this specific delivery attempt (prefixed with HOOK#). Changes with each retry. |
event_type | string | "order.updated""payout.updated""payout.item.updated""payin.updated" | Type of event. See Webhook Events for available types. |
data | object | varies by event type | Event-specific data. Structure varies by event type (see below). |
signature | object | <Signature> | Signature information for payload verification. |
timestamp | integer | 1530291411 | Unix timestamp (seconds) when this hook was sent. |
sent_at | string | "2018-07-18T08:35:20.000Z" | ISO 8601 timestamp when this hook was sent. Same time as timestamp, different format. |
signature object
| Name | Type | Example / Possible values | Description |
|---|---|---|---|
properties | array of strings | ["order.id", "order.status", "order.amount"] | List of properties used to generate the checksum. Extract these dynamically. |
checksum | string | "124F3E92EA81EAC6DAB684035557433BA1922A7A47FED49F2001E831B5185C7E" | SHA256 hash for verifying payload authenticity. See Verifying Signatures. |
Data Object Structure
The data object contains the complete entity as returned by the corresponding GET endpoint:
| Event Type | Data Field | Equivalent API Response |
|---|---|---|
order.updated | data.order | GET /orders/{id}Complete example payload |
payout.updated | data.payout | GET /payouts/{id}Get one payout |
payout.item.updated | data.payout_item | GET /payouts/{payout_id}/items/{item_id}Get one payout item |
payin.updated | data.payin | GET /payins/{id}Get one payin |
HTTP Headers
All webhook requests include:
| Header | Description |
|---|---|
Content-Type | Always application/json |
X-Hook-Checksum | Same value as signature.checksum. Use for convenience. |