Pass Hooks

Webhooks that push information about pass events to your configured target URL.

POSTRequest to webhook target URL

Pass Created

Pushes information about a pass that has been created to the target url.

Event type

pass_created

Target URL

Defined when subscribing.

Submitted Values

JSON object containing the following information:

Name
identifier
Type
string
(mandatory)
Description
The UUID of the pass.
Name
passId
Type
string
(mandatory)
Description
Deprecated. The UUID of the pass. Same value as identifier that should be used.
Name
uniqueIdentifier
Type
string
(mandatory)
Description
The unique identifier of the pass that can be e.g. shown in the barcode and used for ticket validation.
Name
createdOn
Type
string
(mandatory)
Description
The date when the pass was created.
Name
passTemplate
Type
string
(mandatory)
Description
The name of the pass template of this pass.
Name
userProvidedId
Type
string
(mandatory)
Description
If it was specified, the user provided id of the pass that can be used to create download URLs is returned.
Name
buyerEmail
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the email of the buyer is returned here. Otherwise the field is empty.
Name
buyerFirstName
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the firstname of the buyer is returned here. Otherwise the field is empty.
Name
buyerLastName
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the lastname of the buyer is returned here. Otherwise the field is empty.
Name
buyerStreet
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the street of the buyer is returned here. Otherwise the field is empty.
Name
buyerZipCode
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the zip code of the buyer is returned here. Otherwise the field is empty.
Name
buyerCity
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the city of the buyer is returned here. Otherwise the field is empty.
Name
bulkCreationId
Type
string
(mandatory)
Description
If the pass was created via a bulk creation job the ID of the line in the bulk creation jobs' import file that defined the pass is returned. Otherwise the field is empty.
Name
linkToPassPage
Type
string
(mandatory)
Description
Link to the download page for this pass that detects the operating system of the smartphone that is used and provides device specific help. You are encouraged to always use this link when providing the pass to users because it provides the best user experience on all devices.
Name
passTemplateGuid
Type
string
(mandatory)
Description
The GUID of the template that has been used to create this pass.
Name
genericProperties
Type
object
(mandatory)
Description
An array containing the values that you can specify in the extended properties of a pass template.

Dynamic fields:
Additionally to the fields above which are always submitted we'll also submit all data that is personalized. This means that the fields will differ based on the passes pass template. To get a list of personalized fields that will be submitted, use the endpoint that describes a pass template. This means you need to first call the endpoint that describes the dynamic field in order to know what fields are contained in the payload.

Example Payload

Webhook POST request body

{
  "identifier": "12fd53c5-863e-4056-9dbf-2525fa175523",
  "passId": "12fd53c5-863e-4056-9dbf-2525fa175523",
  "uniqueIdentifier": "122501adfa977d7.55989831",
  "createdOn": "2015-04-03 21:30:50",
  "passTemplate": "test",
  "userProvidedId": "",
  "secondaryFields_0_Name": "John Doe",
  "barcodeValue": "Name",
  "barcodeAlternativeText": "Name",
  "expirationDate": "2015-04-17 22:00:00",
  "buyerEmail": "buyer@example.com",
  "buyerFirstName": "John",
  "buyerLastName": "Doe",
  "buyerStreet": "Example ave. 1",
  "buyerZipCode": "012345",
  "buyerCity": "Example City",
  "bulkCreationId": "896789245",
  "linkToPassPage": "https://app.passcreator.com/passinstance/show?passInstance[__identity]=abc123-456weqf489-46wefa",
  "passTemplateGuid": "02fd53c5-863e-4056-9dbf-2525fa171123",
  "genericProperties": {
    "my-id": "12345678",
    "second-field": "Example value"
  }
}

POSTRequest to webhook target URL

Pass Updated

Pushes information about a pass that has been updated to the target url.

Event type

pass_updated

Target URL

Defined when subscribing.

Submitted Values

JSON object containing the following information:

Name
identifier
Type
string
(mandatory)
Description
The UUID of the pass.
Name
passId
Type
string
(mandatory)
Description
Deprecated. The UUID of the pass. Same value as identifier that should be used.
Name
uniqueIdentifier
Type
string
(mandatory)
Description
The unique identifier of the pass that can be e.g. shown in the barcode and used for ticket validation.
Name
createdOn
Type
string
(mandatory)
Description
The date when the pass was created.
Name
passTemplate
Type
string
(mandatory)
Description
The name of the pass template of this pass.
Name
userProvidedId
Type
string
(mandatory)
Description
If it was specified, the user provided id of the pass that can be used to create download URLs is returned.
Name
buyerEmail
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the email of the buyer is returned here. Otherwise the field is empty.
Name
buyerFirstName
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the firstname of the buyer is returned here. Otherwise the field is empty.
Name
buyerLastName
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the lastname of the buyer is returned here. Otherwise the field is empty.
Name
buyerStreet
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the street of the buyer is returned here. Otherwise the field is empty.
Name
buyerZipCode
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the zip code of the buyer is returned here. Otherwise the field is empty.
Name
buyerCity
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the city of the buyer is returned here. Otherwise the field is empty.
Name
bulkCreationId
Type
string
(mandatory)
Description
If the pass was created via a bulk creation job the ID of the line in the bulk creation jobs' import file that defined the pass is returned. Otherwise the field is empty.
Name
linkToPassPage
Type
string
(mandatory)
Description
Link to the download page for this pass that detects the operating system of the smartphone that is used and provides device specific help. You are encouraged to always use this link when providing the pass to users because it provides the best user experience on all devices.
Name
passTemplateGuid
Type
string
(mandatory)
Description
The GUID of the template that has been used to create this pass.
Name
genericProperties
Type
object
(mandatory)
Description
An array containing the values that you can specify in the extended properties of a pass template.

Example Payload

Webhook POST request body

{
  "identifier": "12fd53c5-863e-4056-9dbf-2525fa175523",
  "passId": "12fd53c5-863e-4056-9dbf-2525fa175523",
  "uniqueIdentifier": "122501adfa977d7.55989831",
  "createdOn": "2015-04-03 21:30:50",
  "passTemplate": "test",
  "userProvidedId": "",
  "secondaryFields_0_Name": "John Doe",
  "barcodeValue": "Name",
  "barcodeAlternativeText": "Name",
  "expirationDate": "2015-04-17 22:00:00",
  "buyerEmail": "buyer@example.com",
  "buyerFirstName": "John",
  "buyerLastName": "Doe",
  "buyerStreet": "Example ave. 1",
  "buyerZipCode": "012345",
  "buyerCity": "Example City",
  "bulkCreationId": "896789245",
  "linkToPassPage": "https://app.passcreator.com/passinstance/show?passInstance[__identity]=abc123-456weqf489-46wefa",
  "passTemplateGuid": "02fd53c5-863e-4056-9dbf-2525fa171123",
  "genericProperties": {
    "my-id": "12345678",
    "second-field": "Example value"
  }
}

POSTRequest to webhook target URL

Pass Voided

Pushes information about a wallet pass that has been marked voided (means it is no longer valid and the barcode is greyed out) to the target url.

The voided hook only triggers when the pass becomes voided through an update. It does not trigger if a pass expires and the pass is voided because of the expiration.

Event type

pass_voided

Target URL

Defined when subscribing.

Submitted Values

JSON object containing the following information:

Name
identifier
Type
string
(mandatory)
Description
The identifier of the pass that has been voided.
Name
passId
Type
string
(mandatory)
Description
Deprecated. The identifier of the pass that has been voided. Contains the same value as identifier. identifier should be used.
Name
uniqueIdentifier
Type
string
(mandatory)
Description
The unique identifier of the pass that can be e.g. shown in the barcode and used for ticket validation.
Name
createdOn
Type
string
(mandatory)
Description
The date when the pass was created.
Name
passTemplate
Type
string
(mandatory)
Description
The name of the pass template of this pass.
Name
userProvidedId
Type
string
(mandatory)
Description
If it was specified, the user provided id of the pass that can be used to create download URLs is returned.
Name
buyerEmail
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the email of the buyer is returned here. Otherwise the field is empty.
Name
buyerFirstName
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the firstname of the buyer is returned here. Otherwise the field is empty.
Name
buyerLastName
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the lastname of the buyer is returned here. Otherwise the field is empty.
Name
buyerStreet
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the street of the buyer is returned here. Otherwise the field is empty.
Name
buyerZipCode
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the zip code of the buyer is returned here. Otherwise the field is empty.
Name
buyerCity
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the city of the buyer is returned here. Otherwise the field is empty.
Name
bulkCreationId
Type
string
(mandatory)
Description
If the pass was created via a bulk creation job the ID of the line in the bulk creation jobs' import file that defined the pass is returned. Otherwise the field is empty.
Name
linkToPassPage
Type
string
(mandatory)
Description
Link to the download page for this pass that detects the operating system of the smartphone that is used and provides device specific help. You are encouraged to always use this link when providing the pass to users because it provides the best user experience on all devices.
Name
passTemplateGuid
Type
string
(mandatory)
Description
The GUID of the template that has been used to create this pass.
Name
genericProperties
Type
object
(mandatory)
Description
An array containing the values that you can specify in the extended properties of a pass template.

Example Payload

Webhook POST request body

{
  "identifier": "12fd53c5-863e-4056-9dbf-2525fa175523",
  "passId": "12fd53c5-863e-4056-9dbf-2525fa175523",
  "uniqueIdentifier": "122501adfa977d7.55989831",
  "createdOn": "2015-04-03 21:30:50",
  "passTemplate": "test",
  "userProvidedId": "",
  "secondaryFields_0_Name": "John Doe",
  "barcodeValue": "Name",
  "barcodeAlternativeText": "Name",
  "expirationDate": "2015-04-17 22:00:00",
  "buyerEmail": "buyer@example.com",
  "buyerFirstName": "John",
  "buyerLastName": "Doe",
  "buyerStreet": "Example ave. 1",
  "buyerZipCode": "012345",
  "buyerCity": "Example City",
  "bulkCreationId": "896789245",
  "linkToPassPage": "https://app.passcreator.com/passinstance/show?passInstance[__identity]=abc123-456weqf489-46wefa",
  "passTemplateGuid": "02fd53c5-863e-4056-9dbf-2525fa171123",
  "genericProperties": {
    "my-id": "12345678",
    "second-field": "Example value"
  }
}

POSTRequest to webhook target URL

Pass Downloaded for the First Time

Pushes information about a pass that has been saved on a phone for the first time. This event is triggered when a pass was saved in Wallet for the first time (e.g. if you have multiple devices synchronized through iCloud it will only be executed once).

Event type

first_pushnotification_registered

Target URL

Defined when subscribing.

Submitted Values

JSON object containing the following information:

Name
identifier
Type
string
(mandatory)
Description
The UUID of the pass.
Name
uniqueIdentifier
Type
string
(mandatory)
Description
The unique identifier of the pass that can be e.g. shown in the barcode and used for ticket validation.
Name
createdOn
Type
string
(mandatory)
Description
The date when the pass was downloaded.
Name
passTemplate
Type
string
(mandatory)
Description
The name of the pass template of this pass.
Name
userProvidedId
Type
string
(mandatory)
Description
If it was specified, the user provided id of the pass that can be used to create download URLs is returned.
Name
bulkCreationId
Type
string
(mandatory)
Description
If the pass was created via a bulk creation job the ID of the line in the bulk creation jobs' import file that defined the pass is returned. Otherwise the field is empty.
Name
noOfActivePasses
Type
integer
(mandatory)
Description
Current number of active passes.
Name
noOfInactivePasses
Type
integer
(mandatory)
Description
Current number of inactive passes.
Name
buyerEmail
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the email of the buyer is returned here. Otherwise the field is empty.
Name
buyerFirstName
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the firstname of the buyer is returned here. Otherwise the field is empty.
Name
buyerLastName
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the lastname of the buyer is returned here. Otherwise the field is empty.
Name
buyerStreet
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the street of the buyer is returned here. Otherwise the field is empty.
Name
buyerZipCode
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the zip code of the buyer is returned here. Otherwise the field is empty.
Name
buyerCity
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the city of the buyer is returned here. Otherwise the field is empty.
Name
bulkCreationId
Type
string
(mandatory)
Description
If the pass was created via a bulk creation job the ID of the line in the bulk creation jobs' import file that defined the pass is returned. Otherwise the field is empty.
Name
linkToPassPage
Type
string
(mandatory)
Description
Link to the download page for this pass that detects the operating system of the smartphone that is used and provides device specific help. You are encouraged to always use this link when providing the pass to users because it provides the best user experience on all devices.
Name
passTemplateGuid
Type
string
(mandatory)
Description
The GUID of the template that has been used to create this pass.
Name
operatingSystem
Type
string
(mandatory)
Description
The operating system of the device. Possible values: iOS, AndroidGooglePay, Android, AndroidWalletPasses, AndroidWalletUnion, WindowsPhone.
Name
genericProperties
Type
object
(mandatory)
Description
An array containing the values that you can specify in the extended properties of a pass template.

Example Payload

Webhook POST request body

{
  "identifier": "12fd53c5-863e-4056-9dbf-2525fa175523",
  "uniqueIdentifier": "122501adfa977d7.55989831",
  "createdOn": "2015-04-03 21:30:50",
  "passTemplate": "test",
  "userProvidedId": "",
  "bulkCreationId": "",
  "noOfActivePasses": 1,
  "noOfInactivePasses": 0,
  "secondaryFields_0_Name": "John Doe",
  "barcodeValue": "Name",
  "barcodeAlternativeText": "Name",
  "expirationDate": "2015-04-17 22:00:00",
  "buyerEmail": "buyer@example.com",
  "buyerFirstName": "John",
  "buyerLastName": "Doe",
  "buyerStreet": "Example ave. 1",
  "buyerZipCode": "012345",
  "buyerCity": "Example City",
  "bulkCreationId": "896789245",
  "linkToPassPage": "https://app.passcreator.com/passinstance/show?passInstance[__identity]=abc123-456weqf489-46wefa",
  "passTemplateGuid": "02fd53c5-863e-4056-9dbf-2525fa171123",
  "operatingSystem": "iOS",
  "genericProperties": {
    "my-id": "12345678",
    "second-field": "Example value"
  }
}

POSTRequest to webhook target URL

Pass Downloaded

Pushes information about a pass that has been saved on a smartphone. This event either happens when a user saves the pass on their device for the first time or the user has disabled push notifications and re-enables it again. After this event happened, the pass is active. Please note that one pass can be active multiple times if it is saved on different phones.

Event type

pushnotification_registered

Target URL

Defined when subscribing.

Submitted Values

JSON object containing the following information:

Name
identifier
Type
string
(mandatory)
Description
The UUID of the pass.
Name
uniqueIdentifier
Type
string
(mandatory)
Description
The unique identifier of the pass that can be e.g. shown in the barcode and used for ticket validation.
Name
createdOn
Type
string
(mandatory)
Description
The date when the pass was downloaded.
Name
passTemplate
Type
string
(mandatory)
Description
The name of the pass template of this pass.
Name
userProvidedId
Type
string
(mandatory)
Description
If it was specified, the user provided id of the pass that can be used to create download URLs is returned.
Name
bulkCreationId
Type
string
(mandatory)
Description
If the pass was created via a bulk creation job the ID of the line in the bulk creation jobs' import file that defined the pass is returned. Otherwise the field is empty.
Name
noOfActivePasses
Type
integer
(mandatory)
Description
Current number of active passes.
Name
noOfInactivePasses
Type
integer
(mandatory)
Description
Current number of inactive passes.
Name
buyerEmail
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the email of the buyer is returned here. Otherwise the field is empty.
Name
buyerFirstName
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the firstname of the buyer is returned here. Otherwise the field is empty.
Name
buyerLastName
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the lastname of the buyer is returned here. Otherwise the field is empty.
Name
buyerStreet
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the street of the buyer is returned here. Otherwise the field is empty.
Name
buyerZipCode
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the zip code of the buyer is returned here. Otherwise the field is empty.
Name
buyerCity
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the city of the buyer is returned here. Otherwise the field is empty.
Name
bulkCreationId
Type
string
(mandatory)
Description
If the pass was created via a bulk creation job the ID of the line in the bulk creation jobs' import file that defined the pass is returned. Otherwise the field is empty.
Name
linkToPassPage
Type
string
(mandatory)
Description
Link to the download page for this pass that detects the operating system of the smartphone that is used and provides device specific help. You are encouraged to always use this link when providing the pass to users because it provides the best user experience on all devices.
Name
passTemplateGuid
Type
string
(mandatory)
Description
The GUID of the template that has been used to create this pass.
Name
operatingSystem
Type
string
(mandatory)
Description
The operating system of the device. Possible values: iOS, AndroidGooglePay, Android, AndroidWalletPasses, AndroidWalletUnion, WindowsPhone.
Name
genericProperties
Type
object
(mandatory)
Description
An array containing the values that you can specify in the extended properties of a pass template.

Example Payload

Webhook POST request body

{
  "identifier": "12fd53c5-863e-4056-9dbf-2525fa175523",
  "uniqueIdentifier": "122501adfa977d7.55989831",
  "createdOn": "2015-04-03 21:30:50",
  "passTemplate": "test",
  "userProvidedId": "",
  "bulkCreationId": "",
  "noOfActivePasses": 1,
  "noOfInactivePasses": 0,
  "secondaryFields_0_Name": "John Doe",
  "barcodeValue": "Name",
  "barcodeAlternativeText": "Name",
  "expirationDate": "2015-04-17 22:00:00",
  "buyerEmail": "buyer@example.com",
  "buyerFirstName": "John",
  "buyerLastName": "Doe",
  "buyerStreet": "Example ave. 1",
  "buyerZipCode": "012345",
  "buyerCity": "Example City",
  "bulkCreationId": "896789245",
  "linkToPassPage": "https://app.passcreator.com/passinstance/show?passInstance[__identity]=abc123-456weqf489-46wefa",
  "passTemplateGuid": "02fd53c5-863e-4056-9dbf-2525fa171123",
  "operatingSystem": "iOS",
  "genericProperties": {
    "my-id": "12345678",
    "second-field": "Example value"
  }
}

POSTRequest to webhook target URL

Pass Removed from Phone

Pushes information about a pass that has been deleted from a smartphone or the user disables push notifications for the pass.

Please note that this webhook fires for every device that has saved a pass. It doesn't mean the pass in question was removed from all phones. Check the noOfActivePasses property to determine if the pass was removed from all phones.

Event type

pushnotification_unregistered

Target URL

Defined when subscribing.

Submitted Values

JSON object containing the following information:

Name
identifier
Type
string
(mandatory)
Description
The UUID of the pass.
Name
uniqueIdentifier
Type
string
(mandatory)
Description
The unique identifier of the pass that can be e.g. shown in the barcode and used for ticket validation.
Name
createdOn
Type
string
(mandatory)
Description
The date when the pass was removed from a phone or disabled updates.
Name
passTemplate
Type
string
(mandatory)
Description
The name of the pass template of this pass.
Name
userProvidedId
Type
string
(mandatory)
Description
If it was specified, the user provided id of the pass that can be used to create download URLs is returned.
Name
buyerEmail
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the email of the buyer is returned here. Otherwise the field is empty.
Name
buyerFirstName
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the firstname of the buyer is returned here. Otherwise the field is empty.
Name
buyerLastName
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the lastname of the buyer is returned here. Otherwise the field is empty.
Name
buyerStreet
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the street of the buyer is returned here. Otherwise the field is empty.
Name
buyerZipCode
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the zip code of the buyer is returned here. Otherwise the field is empty.
Name
buyerCity
Type
string
(mandatory)
Description
If the pass was sold with Passcreator the city of the buyer is returned here. Otherwise the field is empty.
Name
bulkCreationId
Type
string
(mandatory)
Description
If the pass was created via a bulk creation job the ID of the line in the bulk creation jobs' import file that defined the pass is returned. Otherwise the field is empty.
Name
noOfActivePasses
Type
integer
(mandatory)
Description
Current number of active passes.
Name
noOfInactivePasses
Type
integer
(mandatory)
Description
Current number of inactive passes.
Name
linkToPassPage
Type
string
(mandatory)
Description
Link to the download page for this pass that detects the operating system of the smartphone that is used and provides device specific help. You are encouraged to always use this link when providing the pass to users because it provides the best user experience on all devices.
Name
passTemplateGuid
Type
string
(mandatory)
Description
The GUID of the template that has been used to create this pass.
Name
operatingSystem
Type
string
(mandatory)
Description
The operating system of the device. Possible values: iOS, AndroidGooglePay, Android, AndroidWalletPasses, AndroidWalletUnion, WindowsPhone.
Name
genericProperties
Type
object
(mandatory)
Description
An array containing the values that you can specify in the extended properties of a pass template.

Example Payload

Webhook POST request body

{
  "identifier": "12fd53c5-863e-4056-9dbf-2525fa175523",
  "uniqueIdentifier": "122501adfa977d7.55989831",
  "createdOn": "2015-04-03 21:30:50",
  "passTemplate": "test",
  "userProvidedId": "",
  "secondaryFields_0_Name": "John Doe",
  "barcodeValue": "Name",
  "barcodeAlternativeText": "Name",
  "expirationDate": "2015-04-17 22:00:00",
  "buyerEmail": "buyer@example.com",
  "buyerFirstName": "John",
  "buyerLastName": "Doe",
  "buyerStreet": "Example ave. 1",
  "buyerZipCode": "012345",
  "buyerCity": "Example City",
  "bulkCreationId": "896789245",
  "noOfActivePasses": 1,
  "noOfInactivePasses": 0,
  "linkToPassPage": "https://app.passcreator.com/passinstance/show?passInstance[__identity]=abc123-456weqf489-46wefa",
  "passTemplateGuid": "02fd53c5-863e-4056-9dbf-2525fa171123",
  "operatingSystem": "iOS",
  "genericProperties": {
    "my-id": "12345678",
    "second-field": "Example value"
  }
}