Skip to main content
PUT
Update webhook endpoint event subscriptions

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Required. At most 255 characters of valid UTF-8 with no NUL byte; a missing key is refused with 400 idempotency_key_required and a malformed one with 400 invalid_idempotency_key. A retry with the same key and body returns the original successful response for 24 hours; a request that failed can be sent again under the same key. The same key with a different body is refused with 409 idempotency_key_conflict, and while the first request is still running with 409 idempotency_key_in_progress and a Retry-After header.

Required string length: 1 - 255

Path Parameters

id
string
required
Pattern: ^whs_[A-Za-z0-9_-]+$

Body

application/json
event_types
string[]
required

A type the endpoint already subscribes to can be kept or removed. Removing one listed with accepts_new_subscriptions false, or no longer listed, is permanent: it cannot be added back. A type the list adds must be one GET /v1/webhooks/event-types lists with accepts_new_subscriptions true (absent means true). One listed with false is refused with 422 validation_failed and an event_types error reading No longer offered for new subscriptions: <types>; one not listed is refused the same way as Unknown event type: <types>. A list naming both kinds gets both errors in one response.

Minimum array length: 1

Response

Webhook resource

data
object
required