PATCH
/
api
/
v1
/
webhook-subscriptions
/
{id}
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"
      ]
    }
  }
}
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

​
id
string
required

Webhook subscription ID

Body

application/json

Webhook subscription update configuration

Response

200
application/json

Webhook subscription updated successfully

The response is of type object.