Pass Removed
Webhook triggered when a pass is removed from the wallet by user
{
"data": {
"id": "018d8e07-beaa-7634-80a8-647cd33d6bb3",
"type": "webhook",
"attributes": {
"timeStamp": "2022-01-01T00:00:00Z",
"webhookType": "passRemoved"
},
"relationships": {
"pass": {
"data": {
"id": "313c3c3b950d30d7ecec486ddf9adf33b887ae29",
"type": "pass"
}
}
}
},
"included": [
{
"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": {
"type": "qrCode",
"value": "123abcd",
"displayText": true
}
}
}
]
}{
"status": "ok"
}Authorizations
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.
Body
Auto-generated UUID of the webhook
"018d8e07-beaa-7634-80a8-647cd33d6bb3"
"webhook"
Relationships to other resources.
Auto-generated UUID of the pass
"e89b1330fc391ec89656f3c664318cff8805471e"
"pass"
Unique download URL of the pass
Pass Type
generic, eventTicket, storeCard android, iphone In ISO8601 format, UTC
Pass Status
issued, active, removed, deactivated Pass External ID
Tag used for grouping passes
When pass has been added to wallet by the user. In ISO8601 format, UTC
When pass has been removed from wallet by the user. In ISO8601 format, UTC
When pass has been deactivated. In ISO8601 format, UTC
Pass will expire at this time. In ISO8601 format, UTC
UUID of corresponding pass template
Name of corresponding pass template
If present, the NFC message to be conveyed when the pass is tapped
If present, the last push message sent to the pass
The templateKey identifies an individual pass field in the pass template, using the template field ID. The value is the assigned value for a specific field and is displayed on the pass. For example, {'fullName': 'Jane Smith'} corresponds to the 'fullName' template field ID.
Pass design values, present if pass template has been overridden for this pass, or if 'includePassDesign' query param is set to true
Pass background color in hex format
"#EFEFEF"
Pass label color in hex format. Only valid for iphone passes
"#EFEFEF"
Pass text color in hex format. Only valid for iphone passes
"#EFEFEF"
URL of pass banner image
URL of pass logo image
Locations, present if 'includeLocations' query param is set to true
Name of the location, used for display purposes only
"West Entrance"
Latitude of the location
51.54321132456805
Longitude of the location
-0.022901231803803924
Effective geofence radius of the location in meters. Maximum is 1000 for eventTicket passes, 100 for other pass types
10 <= x <= 100090
Message to display when user enters geofence
"Welcome! Enjoy the show!"
Geocoded address of the location. Used for display purposes only. This is calculated automatically from the latitude and longitude values
"Mick's Garage, Queens Yard, London, England, E9 5EN, United Kingdom"
Beacons, present if 'includeBeacons' query param is set to true
Unique identifier of the beacon
"E2C56DB5-DFFB-48D2-B060-D0F5A71096E0"
Major Value, provides additional identification for a beacon
65535
Minor Value, provides additional identification for a beacon
8525
Message to display on lock screen when the user is in range of the beacon
"You're near my store"
Name of the beacon, used for display purposes only
"West Entrance"
Pass source, present if 'includePassDesign' query param is present, one of Apple/Google and current pass status is not 'active'.
Apple Wallet Pass Base64 string, to generate the pass, decode the string and save as a .pkpass file. Will prompt the user to download the pass to their Apple Wallet when opened on an iPhone.
Google Wallet Pass download URL. Will prompt the user to download the pass to their Google Wallet when opened on an Android device.
Response
The response is of type any.
Was this page helpful?
{
"data": {
"id": "018d8e07-beaa-7634-80a8-647cd33d6bb3",
"type": "webhook",
"attributes": {
"timeStamp": "2022-01-01T00:00:00Z",
"webhookType": "passRemoved"
},
"relationships": {
"pass": {
"data": {
"id": "313c3c3b950d30d7ecec486ddf9adf33b887ae29",
"type": "pass"
}
}
}
},
"included": [
{
"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": {
"type": "qrCode",
"value": "123abcd",
"displayText": true
}
}
}
]
}{
"status": "ok"
}