Pass Scanned

Authorizations

X-Webhook-Signature

string

header

required

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

application/json

data

object

Show child attributes

data.id

string

Auto-generated UUID of the webhook

Example:

"018d8e07-beaa-7634-80a8-647cd33d6bb3"

data.type

string

Example:

"webhook"

data.attributes

object

Show child attributes

data.attributes.timeStamp

string

In ISO8601 format, UTC. Used to determine when the webhook was triggered

Example:

"2022-09-15T11:45:00Z"

data.attributes.webhookType

enum<string>

Type of webhook

Available options:

passInstalled,

passRemoved,

passTapped,

passScanned,

passCreated

data.relationships

object

Relationships to other resources.

Show child attributes

data.relationships.pass

object

Show child attributes

data.relationships.pass.pass

object

Show child attributes

data.relationships.pass.pass.data

object

Show child attributes

data.relationships.pass.pass.data.id

string

Auto-generated UUID of the pass

Example:

"e89b1330fc391ec89656f3c664318cff8805471e"

data.relationships.pass.pass.data.type

string

Example:

"pass"

data.relationships.passTap

object

Show child attributes

data.relationships.passTap.passTap

object

Show child attributes

data.relationships.passTap.passTap.data

object

Show child attributes

data.relationships.passTap.passTap.data.id

string

Auto-generated UUID of the pass tap

Example:

"857e764e-ec8d-4348-abfb-25f379983eaf"

data.relationships.passTap.passTap.data.type

string

Example:

"passTap"

data.relationships.scan

object

Show child attributes

data.relationships.scan.scan

object

Show child attributes

data.relationships.scan.scan.data

object

Show child attributes

data.relationships.scan.scan.data.id

string

Auto-generated UUID of the scan

Example:

"0194a887-f880-703f-b8cf-16c1ea804b08"

data.relationships.scan.scan.data.type

string

Example:

"scan"

data.relationships.reader

object

Show child attributes

data.relationships.reader.reader

object

Show child attributes

data.relationships.reader.reader.data

object

Show child attributes

data.relationships.reader.reader.data.id

string

Reader ID

Example:

"CC202952"

data.relationships.reader.reader.data.type

string

Example:

"reader"

included

object[]

Option 1
Option 2
Option 3

Show child attributes

included.id

string

Auto-generated UUID of the pass

Example:

"e89b1330fc391ec89656f3c664318cff8805471e"

included.type

string

Example:

"pass"

included.attributes

object

Show child attributes

included.attributes.downloadUrl

string

Unique download URL of the pass

included.attributes.passType

enum<string>

Pass Type

Available options:

generic,

eventTicket,

storeCard,

transit

included.attributes.deviceType

enum<string>

Available options:

android,

iphone

included.attributes.createdAt

string

In ISO8601 format, UTC

included.attributes.status

enum<string>

Pass Status

Available options:

issued,

active,

removed,

deactivated

included.attributes.extId

string | null

Pass External ID

included.attributes.groupTag

string | null

Tag used for grouping passes

included.attributes.groupTags

array | null

Tag used for grouping passes

included.attributes.addedAt

string | null

When pass has been added to wallet by the user. In ISO8601 format, UTC

included.attributes.removedAt

string | null

When pass has been removed from wallet by the user. In ISO8601 format, UTC

included.attributes.deactivatedAt

string | null

When pass has been deactivated. In ISO8601 format, UTC

included.attributes.expiresAt

string | null

Pass will expire at this time. In ISO8601 format, UTC

included.attributes.passTemplateUuid

string

UUID of corresponding pass template

included.attributes.passTemplateName

string

Name of corresponding pass template

included.attributes.nfc

string | null

If present, the NFC message to be conveyed when the pass is tapped

included.attributes.barcode

object

If present, the barcode type and value

Show child attributes

included.attributes.barcode.enabled

boolean

Barcode enabled

included.attributes.barcode.type

enum<string>

Barcode type

Available options:

qr,

code128,

aztec,

pdf417

included.attributes.barcode.source

enum<string>

Barcode source

Available options:

uuid,

extId,

custom

included.attributes.barcode.value

string

Barcode value

Example:

"123abcd"

included.attributes.barcode.displayText

boolean

If true, display the barcode value as text on the pass

included.attributes.latestMessage

string | null

If present, the last push message sent to the pass

included.attributes.passContent

object

Show child attributes

included.attributes.passContent.{key}

The templateKey identifies a pass field in the template (using the template field ID). Its value must be an object with a required value string, and may optionally include a localisation object that maps locale codes to translated values.

Example:

{
  "eventName": {
    "value": "Summer Festival",
    "localisation": {
      "es": { "value": "Festival de Verano" },
      "fr": { "value": "Festival d'Été" }
    }
  }
}

included.attributes.passDesign

object

Pass design values, present if pass template has been overridden for this pass, or if 'includePassDesign' query param is set to true

Show child attributes

included.attributes.passDesign.backgroundColor

string

Pass background color in hex format

Example:

"#EFEFEF"

included.attributes.passDesign.labelColor

string

Pass label color in hex format. Only valid for iphone passes

Example:

"#EFEFEF"

included.attributes.passDesign.textColor

string

Pass text color in hex format. Only valid for iphone passes

Example:

"#EFEFEF"

included.attributes.passDesign.bannerImageUrl

string

URL of pass banner image

included.attributes.passDesign.logoImageUrl

string

URL of pass logo image

included.attributes.locations

object[]

Locations, present if 'includeLocations' query param is set to true

Show child attributes

included.attributes.locations.name

string

Name of the location, used for display purposes only

Example:

"West Entrance"

included.attributes.locations.latitude

number<double>

Latitude of the location

Example:

51.54321132456805

included.attributes.locations.longitude

number<double>

Longitude of the location

Example:

-0.022901231803803924

included.attributes.locations.radius

integer

default:100

Effective geofence radius of the location in meters. Maximum is 1000 for eventTicket passes, 100 for other pass types. Currently only available on Apple devices, due to Android device restrictions.

Required range: 10 <= x <= 1000

Example:

90

included.attributes.locations.message

string

Message to display when user enters geofence. Currently only available on Apple devices, due to Android device restrictions.

Example:

"Welcome! Enjoy the show!"

included.attributes.locations.address

string

Geocoded address of the location. Used for display purposes only. This is calculated automatically from the latitude and longitude values

Example:

"Mick's Garage, Queens Yard, London, England, E9 5EN, United Kingdom"

included.attributes.beacons

object[]

Beacons, present if 'includeBeacons' query param is set to true

Show child attributes

included.attributes.beacons.proximityUuid

string

Unique identifier of the beacon

Example:

"E2C56DB5-DFFB-48D2-B060-D0F5A71096E0"

included.attributes.beacons.major

integer

Major Value, provides additional identification for a beacon

Example:

65535

included.attributes.beacons.minor

integer

Minor Value, provides additional identification for a beacon

Example:

8525

included.attributes.beacons.message

string | null

Message to display on lock screen when the user is in range of the beacon

Example:

"You're near my store"

included.attributes.beacons.name

string

Name of the beacon, used for display purposes only

Example:

"West Entrance"

included.attributes.passSource

object

Pass source, present if 'includePassDesign' query param is present, one of Apple/Google and current pass status is not 'active'.

Show child attributes

included.attributes.passSource.oneOf

object

Show child attributes

included.attributes.passSource.oneOf.appleBase64

string

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.

included.attributes.passSource.oneOf.googleDownloadUrl

string

Google Wallet Pass download URL. Will prompt the user to download the pass to their Google Wallet when opened on an Android device.

Response

200 - application/json

Return a 200 status to indicate that the data was received successfully

Introduction

Entities

Pass Templates

Passes

Readers

Scans

Loyalty

Webhook Subscriptions

Webhooks

Batches

Authorizations

Body

Response