Anatomy

Here is an example of an event

{
    "created": "2012-11-05T00:11:10Z",
    "id": "b9cbf3b7-e02d-4fd8-bc2c-15628b8452e8",
    "type": "registration.created",
    "data": {
        "deviceLibraryIdentifier": "44fc0568cc884cc76824a1d506b7903e",
        "passPid": "J_FF0lcTSo2vZLJp-VreOw",
        "passSerialNumber": "27f145d2-5713-4a8d-af64-b269f95ade3b",
        "passTypeIdentifier": "pass.example.id1",
        "passTemplateId": 1
    }
}

Every event object contains a random universally unique identifier (UUID). Further the event does contain a ISO 8601 formated time string that denotes the time when the event was created. The event object also contains a type and depending on the event type the data field can contain additional information.

Events

Pass events

Event Description
pass.created A pass was generated
pass.updated A pass was updated
pass.downloaded A pass was downloaded
Data Example
  • pid
  • serialNumber
  • passTypeIdentifier
  • templateId
  • url
"data": {
	"pid": "J_FF0lcTSo2vZLJp-VreOw",
    "serialNumber": "27f145d2-5713-4a8d-af64-b269f95ade3b",
    "passTypeIdentifier": "pass.example.id1",
    "templateId": 1,
    "url": "https://d.pslot.io/p/J_FF0lcTSo2vZLJp-VreOw?t=D0rLkv4"
}

Registration events

Event Description
registration.created A device did register to receive push notifications for a Wallet pass.
(Pass was added to Apple Wallet / Wallet)
registration.deleted A device did unregister
(Pass was deleted from Apple Wallet / Wallet or notifications were disabled)
Data Example
  • deviceLibraryIdentifier
  • passPid
  • passSerialNumber
  • passTypeIdentifier
  • passTemplateId
"data": {
    "deviceLibraryIdentifier": "44fc0568cc884cc76824a1d506b7903e",
    "passPid": "J_FF0lcTSo2vZLJp-VreOw",
    "passSerialNumber": "27f145d2-5713-4a8d-af64-b269f95ade3b",
    "passTypeIdentifier": "pass.example.id1",
    "passTemplateId": 1
}

Scan events

Event Description
scan.performed A pass was scanned using the PassSlot redemption system
Data Example
  • scanner (optional)
  • passPid
  • passSerialNumber
  • passTypeIdentifier
  • passTemplateId
  • action (scan, redeem, reactivate, update
  • time
  • authorized
  • updateField (optional)
  • updateValue (optional)
"data": {
    "scanner": 2,
    "passPid": "J_FF0lcTSo2vZLJp-VreOw",
    "passSerialNumber": "27f145d2-5713-4a8d-af64-b269f95ade3b",
    "passTypeIdentifier": "pass.example.id1",
    "passTemplateId": 1,
    "action": "update",
    "time": "2015-06-06T06:06:06Z",
    "authorized": true,
    "updateField": "balance",
    "updateValue": "10.55"
}

Webhook events

Event Description
webhook.verify This event is sent when the webhook needs to be verified. You need to return the sent token in the response together with a HTTP 200 status in order to successfully verify your webhook.
Data Example
  • token
"data": {
    "token": "bXRsTAQrQHMIGSbqREWSmtIYlPvooASW",
}