{
"event_type": "scans.scan_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.absentee_address": 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.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.sub_account_id": 5,
"order.status": "Fulfilled",
"order.metadata": {
"crm_deal_id": "D-1042"
},
"order_item.delivery_date": "2025-06-05",
"order_item.current_status": "Processing",
"qrcode.url": "https://www.google.com"
},
"timestamp": 1750817946,
"date_time": "2025-06-25 02:19:06"
}Webhook Events
QR Code Scans
Webhook payload for QR code scan events
WEBHOOK
qrCodeScanUpdate
{
"event_type": "scans.scan_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.absentee_address": 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.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.sub_account_id": 5,
"order.status": "Fulfilled",
"order.metadata": {
"crm_deal_id": "D-1042"
},
"order_item.delivery_date": "2025-06-05",
"order_item.current_status": "Processing",
"qrcode.url": "https://www.google.com"
},
"timestamp": 1750817946,
"date_time": "2025-06-25 02:19:06"
}This webhook is sent when a recipient scans a thanks.io QR code. The payload includes the scan context and the QR destination URL.
Authorizations
Bearer token authentication using your thanks.io API key
Body
application/json
Example:
"scans.scan_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?