v6

latestOpenAPI 3.1.02026-08-047720752.5 KB

Webhooks

Update a webhook

Update a webhook and associated subscriptions.

Required scopes: webhook:read-write.

patch/v2/webhooks/{webhook_id}

Path parameters

webhook_idstring uuid required

A UUID which identifies the webhook.

Example:23e42eaf-323a-41da-b5bb-fd67eebda553

Request body

Example request

{
  "data": {
    "target_url": "https://example.com/webhook",
    "subscriptions": [
      {
        "event_type": "note.created"
      }
    ]
  }
}

Response

Success

Example response

{
  "data": {
    "target_url": "https://example.com/webhook",
    "subscriptions": [
      {
        "event_type": "note.created"
      }
    ],
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "webhook_id": "23e42eaf-323a-41da-b5bb-fd67eebda553"
    },
    "status": "active",
    "created_at": "2023-04-27T13:22:49.061281000Z"
  }
}