Pass Template Hooks

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

POSTRequest to webhook target URL

Pass Template Created

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

Event type

pass_template_created

Target URL

Defined when subscribing.



Submitted Values

  • Name
    uniqueIdentifier
    Type
    string
    (mandatory)
    Description

    The unique identifier of the template that has been created.

  • Name
    name
    Type
    string
    (mandatory)
    Description

    The name of the template that has been created.

  • Name
    noOfActivePasses
    Type
    integer
    (mandatory)
    Description

    The number of active passes (will be always zero after creation).

  • Name
    noOfCreatedPasses
    Type
    integer
    (mandatory)
    Description

    The number of passes that have been created using the template (will also be zero after creation).

Example Payload

Webhook POST request body

{
  "uniqueIdentifier": "9bb306e2-42c9-4146-9a95-d788365ba9af",
  "name": "test",
  "noOfActivePasses": 0,
  "noOfCreatedPasses": 0
}

POSTRequest to webhook target URL

Pass Template Updated

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

Event type

pass_template_updated

Target URL

Defined when subscribing.



Submitted Values

  • Name
    uniqueIdentifier
    Type
    string
    (mandatory)
    Description

    The unique identifier of the template that has been updated.

  • Name
    name
    Type
    string
    (mandatory)
    Description

    The name of the template that has been updated.

  • Name
    noOfActivePasses
    Type
    integer
    (mandatory)
    Description

    The number of active passes.

  • Name
    noOfCreatedPasses
    Type
    integer
    (mandatory)
    Description

    The number of passes that have been created using the template.

Example Payload

Webhook POST request body

{
  "uniqueIdentifier": "9bb306e2-42c9-4146-9a95-d788365ba9af",
  "name": "test",
  "noOfActivePasses": 0,
  "noOfCreatedPasses": 0
}