WEBHOOK
passTapped
{
  "data": {
    "id": "018d8e07-beaa-7634-80a8-647cd33d6bb3",
    "type": "webhook",
    "attributes": {
      "timeStamp": "2022-01-01T00:00:00Z",
      "webhookType": "passTapped"
    },
    "relationships": {
      "passTap": {
        "data": {
          "id": "857e764e-ec8d-4348-abfb-25f379983eaf",
          "type": "passTap"
        }
      },
      "scan": {
        "data": {
          "id": "0194b1c7-be50-70f7-88eb-216d58afb575",
          "type": "scan"
        }
      },
      "pass": {
        "data": {
          "id": "313c3c3b950d30d7ecec486ddf9adf33b887ae29",
          "type": "pass"
        }
      },
      "reader": {
        "data": {
          "id": "CC202952",
          "type": "reader"
        }
      }
    }
  },
  "included": [
    {
      "id": "857e764e-ec8d-4348-abfb-25f379983eaf",
      "type": "scan",
      "attributes": {
        "scanType": "nfc",
        "scanValue": "313c3c3b950d30d7ecec486ddf9adf33b887ae29",
        "validationType": "internalValidation",
        "status": "successful",
        "successful": true,
        "statusDetail": null,
        "refusalReason": null,
        "scannedAt": "2025-01-28T10:25:11Z",
        "tappedAt": "2025-01-28T10:25:11Z"
      },
      "relationships": {
        "pass": {
          "data": {
            "id": "313c3c3b950d30d7ecec486ddf9adf33b887ae29",
            "type": "pass"
          }
        },
        "reader": {
          "data": {
            "id": "CC202952",
            "type": "reader"
          }
        }
      }
    },
    {
      "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": {
          "enabled": true,
          "type": "qr",
          "source": "custom",
          "value": "123abcd",
          "displayText": true
        }
      }
    },
    {
      "id": "CC202952",
      "type": "reader",
      "attributes": {
        "name": "West Gate"
      }
    }
  ]
}
{
  "status": "ok"
}

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

Response

200 - application/json

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

The response is of type any.