Sign in

v1

latestOpenAPI 3.1.02026-07-223614164.6 KB
Webhooks

Get a webhook

Retrieve an existing webhook in the workspace.

get/v1/webhooks/{webhookId}

Path parameters

webhookIdstring required

The ID of the webhook to retrieve.

Response

The retrieved webhook in the workspace.

deprecationsstring[]

Example response

{
  "data": {
    "id": "wbk_8c18c158-d49e-4ad4-90d4-2b197688bac7",
    "name": "My app integration",
    "targetUrl": "https://my-app.com/webhook",
    "subscribedEvents": [
      {
        "eventType": "person.created",
        "filter": {}
      }
    ],
    "redactedSigningSecret": "whs_fx**********************oVMa",
    "status": "active",
    "createdAt": "2025-07-17T09:00:00.000Z"
  },
  "deprecations": [
    "This field is deprecated"
  ]
}