v2

latestOpenAPI 3.1.02026-08-074390396.7 KB

Webhook Subscriptions

Create Webhook Subscription

Create a new webhook subscription to receive events

post/api/v1/webhook-subscriptions

Request body

Example request

{
  "webhookSubscription": {
    "url": "https://example.com/webhook",
    "entityId": "7e16b5e1"
  }
}

Response

Webhook subscription created successfully

Example response

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