v2

latestOpenAPI 3.1.02026-08-074390396.7 KB

Webhook Subscriptions

Rotate Secret Key

Generate a new secret key for webhook signature verification. The old key becomes invalid immediately.

patch/api/v1/webhook-subscriptions/{id}/rotate-secret

Response

Secret key rotated successfully

idstring

Unique identifier for the webhook subscription

type'webhookSubscription'

Type of the resource

Example response

{
  "id": "01983282-53cf-7e16-b5e1-dd0de4ce02fa",
  "attributes": {
    "url": "https://example.com/webhook",
    "secretKey": "a2e2c04657b924390d2a2623439c65734d07e0f8",
    "scopeName": "Test Organisation"
  }
}