{
"event_type": "scan_board.status_update",
"event_id": "c4e1aa40-516a-11f0-94e9-4b4494619f64",
"data": {
"order_item.id": 2668661,
"order_item.scans": 4,
"order_item.failure": null,
"recipient.name": "John Doe",
"recipient.company": null,
"recipient.address": "123 Fake St",
"recipient.address2": null,
"recipient.city": "Any Town",
"recipient.province": "NY",
"recipient.postal_code": "12345",
"recipient.country": "US",
"recipient.email": null,
"recipient.phone": null,
"recipient.custom_1": "Example Custom 1",
"recipient.custom_2": "Example Custom 2",
"recipient.absentee_address": null,
"recipient.custom_3": "Example Custom 3",
"recipient.custom_4": "Example Custom 4",
"recipient.custom_5": "Example Custom 5",
"recipient.custom_6": "Example Custom 6",
"recipient.custom_7": "Example Custom 7",
"recipient.custom_8": "Example Custom 8",
"recipient.custom_9": "Example Custom 9",
"recipient.custom_10": "Example Custom 10",
"order.id": 42398,
"order.status": "Fulfilled",
"order.sub_account_id": null,
"order.metadata": {
"crm_deal_id": "D-1042"
},
"order_item.delivery_date": "2025-06-05",
"scan_board.card_id": 1187,
"scan_board.previous_status": "new",
"scan_board.current_status": "contacted",
"scan_board.last_scanned_at": "2025-06-24 23:19:06"
},
"timestamp": 1750817946,
"date_time": "2025-06-25 02:19:06"
}Webhook Events
Scan Board Stage Change
Webhook payload for QR Scan Board stage changes
WEBHOOK
scanBoardStatusUpdate
{
"event_type": "scan_board.status_update",
"event_id": "c4e1aa40-516a-11f0-94e9-4b4494619f64",
"data": {
"order_item.id": 2668661,
"order_item.scans": 4,
"order_item.failure": null,
"recipient.name": "John Doe",
"recipient.company": null,
"recipient.address": "123 Fake St",
"recipient.address2": null,
"recipient.city": "Any Town",
"recipient.province": "NY",
"recipient.postal_code": "12345",
"recipient.country": "US",
"recipient.email": null,
"recipient.phone": null,
"recipient.custom_1": "Example Custom 1",
"recipient.custom_2": "Example Custom 2",
"recipient.absentee_address": null,
"recipient.custom_3": "Example Custom 3",
"recipient.custom_4": "Example Custom 4",
"recipient.custom_5": "Example Custom 5",
"recipient.custom_6": "Example Custom 6",
"recipient.custom_7": "Example Custom 7",
"recipient.custom_8": "Example Custom 8",
"recipient.custom_9": "Example Custom 9",
"recipient.custom_10": "Example Custom 10",
"order.id": 42398,
"order.status": "Fulfilled",
"order.sub_account_id": null,
"order.metadata": {
"crm_deal_id": "D-1042"
},
"order_item.delivery_date": "2025-06-05",
"scan_board.card_id": 1187,
"scan_board.previous_status": "new",
"scan_board.current_status": "contacted",
"scan_board.last_scanned_at": "2025-06-24 23:19:06"
},
"timestamp": 1750817946,
"date_time": "2025-06-25 02:19:06"
}This webhook is sent when a card on your QR Scan Board enters the stage the webhook is set to, at most once per card per stage. Available on the Business plan and up.
Authorizations
Bearer token authentication using your thanks.io API key
Body
application/json
Example:
"scan_board.status_update"
Example:
"c4e1aa40-516a-11f0-94e9-4b4494619f64"
Flat payload object used by webhook events. Each property is a dotted key matching the published webhook payload structure.
Show child attributes
Show child attributes
Example:
1750817946
Example:
"2025-06-25 02:19:06"
Response
200
Webhook received
Was this page helpful?