{
"data": {
"id": "0194a887-f893-7c75-b250-ad2ef4a5d16e",
"type": "webhook",
"attributes": {
"timeStamp": "2022-01-01T00:00:00Z",
"webhookType": "passScanned"
},
"relationships": {
"scan": {
"data": {
"id": "0194a887-f880-703f-b8cf-16c1ea804b08",
"type": "scan"
}
},
"pass": {
"data": {
"id": "313c3c3b950d30d7ecec486ddf9adf33b887ae29",
"type": "pass"
}
},
"reader": {
"data": {
"id": "CC202952",
"type": "reader"
}
}
}
},
"included": [
{
"id": "0194a887-f880-703f-b8cf-16c1ea804b08",
"type": "scan",
"attributes": {
"scanType": "nfc",
"scanValue": "313c3c3b950d30d7ecec486ddf9adf33b887ae29",
"validationType": "internalValidation",
"status": "successful",
"statusDetail": null,
"scannedAt": "2025-01-28T10:25:11Z"
},
"relationships": {
"pass": {
"data": {
"id": "313c3c3b950d30d7ecec486ddf9adf33b887ae29",
"type": "pass"
}
},
"reader": {
"data": {
"id": "CC202952",
"type": "reader"
}
}
}
},
{
"id": "e89b1330fc391ec89656f3c664318cff8805471e",
"type": "pass",
"attributes": {
"downloadUrl": "https://localhost:3001/download?pass=e89b1330fc391ec89656f3c664318cff8805471e",
"passType": "generic",
"deviceType": "android",
"createdAt": "2022-01-01T00:00:00Z",
"status": "removed",
"extId": "0811d028ddf0da42c28f",
"addedAt": "2022-02-01T00:00:00Z",
"removedAt": "2023-02-01T00:00:00Z",
"deactivatedAt": null,
"passTemplateUuid": "c1f632d3e693a75c376b440b",
"passTemplateName": "Pass Template 1 3079",
"nfc": "e89b1330fc391ec89656f3c664318cff8805471e",
"passContent": {
"fullName": "Jane Smith"
},
"barcode": {
"enabled": true,
"type": "qr",
"source": "custom",
"value": "123abcd",
"displayText": true
}
}
},
{
"id": "CC202952",
"type": "reader",
"attributes": {
"name": "West Gate",
"readerType": "VtapReader"
}
}
]
}
{
"status": "ok"
}
Webhook triggered when an NFC or barcode pass is scanned by a reader
{
"data": {
"id": "0194a887-f893-7c75-b250-ad2ef4a5d16e",
"type": "webhook",
"attributes": {
"timeStamp": "2022-01-01T00:00:00Z",
"webhookType": "passScanned"
},
"relationships": {
"scan": {
"data": {
"id": "0194a887-f880-703f-b8cf-16c1ea804b08",
"type": "scan"
}
},
"pass": {
"data": {
"id": "313c3c3b950d30d7ecec486ddf9adf33b887ae29",
"type": "pass"
}
},
"reader": {
"data": {
"id": "CC202952",
"type": "reader"
}
}
}
},
"included": [
{
"id": "0194a887-f880-703f-b8cf-16c1ea804b08",
"type": "scan",
"attributes": {
"scanType": "nfc",
"scanValue": "313c3c3b950d30d7ecec486ddf9adf33b887ae29",
"validationType": "internalValidation",
"status": "successful",
"statusDetail": null,
"scannedAt": "2025-01-28T10:25:11Z"
},
"relationships": {
"pass": {
"data": {
"id": "313c3c3b950d30d7ecec486ddf9adf33b887ae29",
"type": "pass"
}
},
"reader": {
"data": {
"id": "CC202952",
"type": "reader"
}
}
}
},
{
"id": "e89b1330fc391ec89656f3c664318cff8805471e",
"type": "pass",
"attributes": {
"downloadUrl": "https://localhost:3001/download?pass=e89b1330fc391ec89656f3c664318cff8805471e",
"passType": "generic",
"deviceType": "android",
"createdAt": "2022-01-01T00:00:00Z",
"status": "removed",
"extId": "0811d028ddf0da42c28f",
"addedAt": "2022-02-01T00:00:00Z",
"removedAt": "2023-02-01T00:00:00Z",
"deactivatedAt": null,
"passTemplateUuid": "c1f632d3e693a75c376b440b",
"passTemplateName": "Pass Template 1 3079",
"nfc": "e89b1330fc391ec89656f3c664318cff8805471e",
"passContent": {
"fullName": "Jane Smith"
},
"barcode": {
"enabled": true,
"type": "qr",
"source": "custom",
"value": "123abcd",
"displayText": true
}
}
},
{
"id": "CC202952",
"type": "reader",
"attributes": {
"name": "West Gate",
"readerType": "VtapReader"
}
}
]
}
{
"status": "ok"
}
The X-Webhook-Signature
header is generated using the webhook payload and shared secret key.
To verify that the webhook is authentic, you can encrypt the webhook payload using the SHA-256
encryption algorithm and your secret key.
If your generated signature matches the signature included in the X-Webhook-Signature
header, you can confirm that the webhook is authentic.
Return a 200 status to indicate that the data was received successfully
The response is of type any
.
Was this page helpful?