API Docs
API referenceWebhooks

Update a webhook

PATCH/api/v2/webhooks/{id}

An omitted field is unchanged. Needs webhooks:write, plus the read scopes of the events the webhook then receives: payouts:read for payout events, counterparties:read for counterparty events. The caller's credential becomes the webhook's credential.

Path Parameters

id*string

Id of a webhook: webhook_ followed by its key.

Match^webhook_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v2/webhooks/webhook_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e" \  -H "Content-Type: application/json" \  -d '{}'
{  "object": "webhook",  "id": "webhook_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e",  "url": "https://example.com/done",  "events": [    "string"  ],  "enabled": true,  "secret": "string",  "createdAt": "2026-09-24T10:00:00.000Z",  "updatedAt": "2026-09-24T10:00:00.000Z"}