v1

latestOpenAPI 3.1.02026-07-223614164.6 KB

Webhooks

Create a webhook

Creates a new webhook listening to workspace events.

post/v1/webhooks

Request body

namestring required

A friendly name for the webhook.

targetUrlstring uri required

The URL of the webhook. It must be a publicly accessible URL using the HTTP or HTTPS protocol.

Example request

{
  "name": "My app integration",
  "targetUrl": "https://my-app.com/webhook",
  "subscribedEvents": [
    {
      "eventType": "person.created",
      "filter": {
        "groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71"
      }
    }
  ]
}

Response

The created webhook.

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": {}
      }
    ],
    "signingSecret": "whsec_QWFSUzl1QUVoQW1kdWtpTnJRTUFpbXNlZmxLTg==",
    "status": "active",
    "createdAt": "2025-07-17T09:00:00.000Z"
  },
  "deprecations": [
    "This field is deprecated"
  ]
}