Webhooks
A comparison ended
Sent when a comparison you started with POST /v1/compare has ended. Read its parts with GET /v1/compare/{id} when data.status is complete; when it is failed, submit the comparison again.
WEBHOOK
compare.completed
{
"type": "compare.completed",
"timestamp": "2026-10-12T02:49:29.479Z",
"data": {
"compare_id": "f2d22c25-e694-428b-bbb8-3948e60d3c7b",
"status": "complete",
"end_customer_id": null
}
}Headers
The event id, the same on every attempt: use it to ignore a repeat.
When this attempt was sent, in seconds since 1970-01-01 UTC. Reject an old one.
The Standard Webhooks signature of this attempt, made with your endpoint's secret. Check it before trusting the body.
Body
application/json
Response
2XX
Received. Answer within 15 seconds; any other answer, or none, is retried over about three days.
Was this page helpful?
⌘I
{
"type": "compare.completed",
"timestamp": "2026-10-12T02:49:29.479Z",
"data": {
"compare_id": "f2d22c25-e694-428b-bbb8-3948e60d3c7b",
"status": "complete",
"end_customer_id": null
}
}