API referenceWebhooks

Delete a webhook

DELETE/api/v2/webhooks/{id}

Needs webhooks:write.

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}$

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

curl -X DELETE "https://example.com/api/v2/webhooks/webhook_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e"

{  "object": "webhook",  "id": "webhook_0e4ba886-0bfe-4b6a-ae2e-d6d9d135dd1e",  "deleted": true}

Update a webhook PATCH

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.

Rotate the signing secret POST

Replaces the secret. The response carries the new `secret` once. For 24 hours, deliveries carry a signature with the old secret and one with the new, so you can deploy the new secret without dropping events. Needs `webhooks:write`.