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

meta

object

Show child attributes

links

object

Show child attributes

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
  }
}