Webhooks
Webhooks API
Subscribe to system events to receive real-time notifications.
Included with every webhook
These properties are included with each webhook request:
| Key | Type | Description |
|---|---|---|
| type | String | The webhook event type |
| id | ID | Unique identifier for the webhook |
| created_at | string | The timestamp for the webhook |
| payload | string | The payload of the webhook |
Event types
All supported event types and the structured payload objects.
connection.initialized
Connections are initialized when a customer begins linking their account.
| Key | Type | Description |
|---|---|---|
| payload.connection.connection_id | string | Unique identifier for the connection |
| payload.connection.customer_id | string | ID of the associated customer |
| payload.connection.status | string | Current status of the connection |
| payload.connection.merchant_id | string | ID of the linked merchant |
connection.activated
Connections are activated when a customer successfully links their account.
| Key | Type | Description |
|---|---|---|
| payload.connection.connection_id | string | Unique identifier for the connection |
| payload.connection.customer_id | string | ID of the associated customer |
| payload.connection.status | string | Current status of the connection |
| payload.connection.merchant_id | string | ID of the linked merchant |
connection.unauthenticated
Connections move from activated to unauthenticated when a customer needs to re-authenticate their account. For example, when a customer changes their password with the retailer.
| Key | Type | Description |
|---|---|---|
| payload.connection.connection_id | string | Unique identifier for the connection |
| payload.connection.customer_id | string | ID of the associated customer |
| payload.connection.status | string | Current status of the connection |
| payload.connection.merchant_id | string | ID of the linked merchant |
connection.deleted
Connections are deleted when a request to DELETE /connection/{connection_id}
| Key | Type | Description |
|---|---|---|
| payload.connection.connection_id | string | Unique identifier for the connection |
| payload.connection.customer_id | string | ID of the associated customer |
| payload.connection.merchant_id | string | ID of the linked merchant |
purchase.created
| Key | Type | Description |
|---|---|---|
| payload.connection.connection_id | string | Unique identifier for the connection |
| payload.connection.merchant_id | string | ID of the linked merchant |
| payload.purchase.purchase_id | string | Unique identifier for the purchase |
| payload.purchase.date | string | Date of the purchase (ISO 8601) |
| payload.purchase.total | number | Total amount of the purchase |
| payload.purchase.subtotal | number | Subtotal before tax |
| payload.purchase.tax | number | Tax amount |
product.purchased
| Key | Type | Description |
|---|---|---|
| payload.connection.connection_id | string | Unique identifier for the connection |
| payload.connection.merchant_id | string | ID of the linked merchant |
| payload.purchase.purchase_id | string | Unique identifier for the purchase |
| payload.product.product_id | string | Subtotal unique identifier for the product |
| payload.product.identifiers[] | array | Array of external product identifiers |
| payload.product.identifiers[].id_type | string | Type of the identifier (e.g., UPC, GTIN) |
| payload.product.identifiers[].value | string | Value of the product identifier |
product.returned
| Key | Type | Description |
|---|---|---|
| payload.connection.connection_id | string | Unique identifier for the connection |
| payload.connection.merchant_id | string | ID of the linked merchant |
| payload.purchase.purchase_id | string | Unique identifier for the purchase |
| payload.product.product_id | string | Subtotal unique identifier for the product |
| payload.product.identifiers[] | array | Array of external product identifiers |
| payload.product.identifiers[].id_type | string | Type of the identifier (e.g., UPC, GTIN) |
| payload.product.identifiers[].value | string | Value of the product identifier |