List Webhook Subscriptions

GET

api

webhook-subscriptions

curl --request GET \
  --url https://api.passentry.com/api/v1/webhook-subscriptions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "01983282-53cf-7e16-b5e1-dd0de4ce02fa",
      "type": "webhookSubscription",
      "attributes": {
        "url": "https://example.com/webhook",
        "secretKey": "a2e2c04657b924390d2a2623439c65734d07e0f8",
        "enabled": true,
        "scopeType": "organisation",
        "scopeName": "Test Organisation",
        "subscribedEvents": [
          "passInstalled",
          "passRemoved"
        ]
      }
    }
  ],
  "meta": {
    "totalCount": 1,
    "resultsPerPage": 10,
    "currentPage": 1,
    "totalPages": 1
  },
  "links": {
    "first": null,
    "prev": null,
    "next": null,
    "last": null
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

perPage

integer

default:5

Record limiter per page. Default is 5, max is 100

Required range: x <= 100

page

integer

default:1

Page number. Default is 1

entityId

string

Filter by entity ID (for webhook subscriptions scoped to an entity).

Response

Webhook subscriptions listed successfully

data

object[]

Show child attributes

data.id

string

Unique identifier for the webhook subscription

Example:

"01983282-53cf-7e16-b5e1-dd0de4ce02fa"

data.type

enum<string>

Type of the resource

Available options:

webhookSubscription

data.attributes

object

Show child attributes

data.attributes.url

string<uri>

HTTPS URL that will receive webhook events

Example:

"https://example.com/webhook"

data.attributes.secretKey

string

Secret key used to sign webhook payloads

Example:

"a2e2c04657b924390d2a2623439c65734d07e0f8"

data.attributes.enabled

boolean

Whether the webhook subscription is active

data.attributes.scopeType

enum<string>

Scope type for the webhook subscription

Available options:

organisation,

entity

data.attributes.scopeName

string

Name of the scope

Example:

"Test Organisation"

data.attributes.subscribedEvents

enum<string>[]

List of events subscribed to

Available options:

passInstalled,

passRemoved,

passScanned,

passCreated

meta

object

Show child attributes

meta.totalCount

integer

Total count of records returned

meta.resultsPerPage

integer

Number of records returned per page. Set using the perPage query parameter.

meta.currentPage

integer

Index of current page

meta.totalPages

integer

Total pages returned

links

object

Show child attributes

links.first

string | null

Path to first page, null if currentPage is first page

links.prev

string | null

Path to prev page, null if currentPage is first page

links.next

string | null

Path to next page, null if currentPage is last page

links.last

string | null

Path to last page, null if currentPage is last page

Show Webhook SubscriptionGet details of a specific webhook subscription based on ID.

⌘I

List Webhook Subscriptions

curl --request GET \
  --url https://api.passentry.com/api/v1/webhook-subscriptions \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "01983282-53cf-7e16-b5e1-dd0de4ce02fa",
      "type": "webhookSubscription",
      "attributes": {
        "url": "https://example.com/webhook",
        "secretKey": "a2e2c04657b924390d2a2623439c65734d07e0f8",
        "enabled": true,
        "scopeType": "organisation",
        "scopeName": "Test Organisation",
        "subscribedEvents": [
          "passInstalled",
          "passRemoved"
        ]
      }
    }
  ],
  "meta": {
    "totalCount": 1,
    "resultsPerPage": 10,
    "currentPage": 1,
    "totalPages": 1
  },
  "links": {
    "first": null,
    "prev": null,
    "next": null,
    "last": null
  }
}

Introduction

Entities

Pass Templates

Passes

Readers

Scans

Loyalty

Webhook Subscriptions

Webhooks

Batches

List Webhook Subscriptions

Authorizations

Query Parameters

Response