Request Body
The webhook will send a JSON payload with the following structure:Properties
string
Unique identifier for the webhook event
string
The webhook topic
string
ISO 8601 timestamp of when the webhook was created
object
The webhook payload
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
{
"id": "aa58a883-1e6f-4ec1-aa06-556908167f46",
"topic": "claim.created",
"created_at": "2024-03-20T10:00:00Z",
"body": {
"claim_id": "cm6v2zdt10002j20vqs7f74hc",
"order_id": "order-1",
"source_order_id": "100",
"created_at": "2024-03-20T10:00:00Z",
"claim_description": "Item arrived damaged",
"claim_type": "DAMAGED",
"claim_state": "NEW",
"items": [
{
"product_id": "prod001",
"variant_id": "var001",
"sku": "SKU123",
"item_id": "item001",
"item_name": "Wireless Mouse",
"quantity": 1
}
]
}
}
{
"id": "aa58a883-1e6f-4ec1-aa06-556908167f46",
"topic": "claim.created",
"created_at": "2024-03-20T10:00:00Z",
"body": {
"claim_id": "cm6v2zdt10002j20vqs7f74hc",
"order_id": "order-1",
"source_order_id": "100",
"created_at": "2024-03-20T10:00:00Z",
"claim_description": "Item arrived damaged",
"claim_type": "DAMAGED",
"claim_state": "NEW",
"items": [
{
"product_id": "prod001",
"variant_id": "var001",
"sku": "SKU123",
"item_id": "item001",
"item_name": "Wireless Mouse",
"quantity": 1
}
]
}
}
Show Webhook Payload
DAMAGED, DEFECTIVE_ITEM, MISSING_ITEM, MULTIPLE, ORDER_DELIVERED_NOT_RECEIVED, RETURNED_TO_SENDER, STOLEN, WRONG_ITEMAPPROVED, ARCHIVED, CLOSED, COMMUNICATING, DENIED, DISMISSED, NEW, OPEN, RESOLVED, RESOLVED_BY_BRAND, TEMPORARILY_DISMISSED, WAITING_FOR_BRAND, WAITING_FOR_CUSTOMER, WAITING_FOR_OP