v1

latestOpenAPI 3.1.02026-07-223614164.6 KB

Webhooks

Update a webhook

Update an existing webhook in the workspace.

patch/v1/webhooks/{webhookId}

Path parameters

webhookIdstring required

The ID of the webhook to update.

Request body

namestring

A friendly name for the webhook.

targetUrlstring uri

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

status'active' | 'inactive'

The status of the webhook.

Example request

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

Response

The updated 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"
  ]
}