Generate a new secret key for webhook signature verification. The old key becomes invalid immediately.
cURL
curl --request PATCH \ --url https://api.passentry.com/api/v1/webhook-subscriptions/{id}/rotate-secret \ --header 'Authorization: Bearer <token>'
{ "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" ] } }
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
Webhook subscription ID
Secret key rotated successfully
Unique identifier for the webhook subscription
"01983282-53cf-7e16-b5e1-dd0de4ce02fa"
Type of the resource
webhookSubscription
Show child attributes
HTTPS URL that will receive webhook events
"https://example.com/webhook"
Secret key used to sign webhook payloads
"a2e2c04657b924390d2a2623439c65734d07e0f8"
Whether the webhook subscription is active
Scope type for the webhook subscription
organisation
entity
Name of the scope
"Test Organisation"
List of events subscribed to
passInstalled
passRemoved
passScanned
passCreated
Was this page helpful?