Update a webhook

PUT

/v1/webhooks/{id}

Requires WEBHOOKS_MANAGE, granted by WEBHOOKS_WRITE (bundles)

Changes a webhook's URL, event types, description or active state; fields you leave out keep their current values, and the signing secret doesn't change. Set active to false to pause deliveries without deleting the webhook. A key restricted to sub-accounts can't manage webhooks.

Parameters

Path Parameters

id*

Webhook ID: the identifier returned when the webhook was created.

Type

string

Required

Example"0b8f5d2e-7a41-4c3b-9e6d-2f1a8c7b5e90"

Format

"uuid"

Request Body

application/json

{

"eventTypes": [

"FIAT_DEPOSIT_CREDITED",

"CRYPTO_DEPOSIT_CREDITED"

],

"description": "Deposits only"

}

Responses

OK

Samples

Errors

HTTP	Error	When
400	-113INVALID_JSON	The body isn't valid JSON.
400	-11INVALID_REQUEST	The body is empty or a field fails validation; validationErrors lists each failing field.
404	-18121WEBHOOK_SUBSCRIPTION_NOT_FOUND	No webhook with this ID exists for your business.

Plus the errors common to all signed endpoints.