Update Webhook Subscription

PATCH

api

webhook-subscriptions

{id}

curl --request PATCH \
  --url https://api.passentry.com/api/v1/webhook-subscriptions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhookSubscription": {
    "url": "https://example.com/webhook/updated",
    "enabled": false,
    "subscribedEvents": [
      "passInstalled",
      "passRemoved",
      "passCreated"
    ]
  }
}
'

{
  "data": {
    "id": "01983282-53cf-7e16-b5e1-dd0de4ce02fa",
    "type": "webhookSubscription",
    "attributes": {
      "url": "https://example.com/webhook/updated",
      "secretKey": "a2e2c04657b924390d2a2623439c65734d07e0f8",
      "enabled": false,
      "scopeType": "organisation",
      "scopeName": "Test Organisation",
      "subscribedEvents": [
        "passInstalled",
        "passRemoved",
        "passCreated"
      ]
    }
  }
}

Note: The scope (organisation/entity) of a webhook subscription cannot be changed after creation. To change the scope, create a new webhook subscription and delete the old one.

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Webhook subscription ID

Body

application/json

Webhook subscription update configuration

webhookSubscription

object

required

Show child attributes

webhookSubscription.url

string<uri>

HTTPS URL that will receive webhook events

Example:

"https://example.com/webhook"

webhookSubscription.enabled

boolean

Whether the webhook subscription is active

webhookSubscription.subscribedEvents

enum<string>[]

List of events to subscribe to

Minimum array length: 1

Available options:

passInstalled,

passRemoved,

passScanned,

passCreated

Response

Webhook subscription updated 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

List Webhook SubscriptionsGet a list of all webhook subscriptions with pagination and filtering options

⌘I

Update Webhook Subscription

curl --request PATCH \
  --url https://api.passentry.com/api/v1/webhook-subscriptions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhookSubscription": {
    "url": "https://example.com/webhook/updated",
    "enabled": false,
    "subscribedEvents": [
      "passInstalled",
      "passRemoved",
      "passCreated"
    ]
  }
}
'

{
  "data": {
    "id": "01983282-53cf-7e16-b5e1-dd0de4ce02fa",
    "type": "webhookSubscription",
    "attributes": {
      "url": "https://example.com/webhook/updated",
      "secretKey": "a2e2c04657b924390d2a2623439c65734d07e0f8",
      "enabled": false,
      "scopeType": "organisation",
      "scopeName": "Test Organisation",
      "subscribedEvents": [
        "passInstalled",
        "passRemoved",
        "passCreated"
      ]
    }
  }
}

Introduction

Entities

Pass Templates

Passes

Readers

Scans

Loyalty

Webhook Subscriptions

Webhooks

Batches

Update Webhook Subscription

Authorizations

Path Parameters

Body

Response