Skip to main content
PATCH
Update a webhook

Authorizations

Authorization
string
header
required

Your account's secret key: Authorization: Bearer sk_test_… or sk_live_…. Server-side only.

Headers

Idempotency-Key
string

A unique key per operation (a UUID works). Retrying with the same key returns the original response.

Path Parameters

endpointID
string
required
Pattern: ^we_[0-9A-Za-z]{22}$
Example:

"we_3Tz8yU1oI4pA7sD0fG2hJk"

Body

application/json
isActive
boolean

true turns it on, false off. While off, the endpoint receives no deliveries.

events
enum<string>[]

The new list of events. At least one.

Minimum array length: 1
Available options:
checkout.session.created,
checkout.session.completed,
checkout.session.expired,
customer.created,
customer.converted,
invoice.finalized,
invoice.sent,
invoice.paid,
invoice.voided,
invoice.uncollectible,
invoice.auto_collection_failed,
payment.confirmed,
payment.failed,
payment.refunded,
payment.refund_reversed,
payment.chargeback,
payment.chargeback_reversed,
plan.changed,
usage.threshold_reached,
credit.balance_low,
credit.balance_depleted,
subscription.cancel_scheduled,
subscription.cancel_unscheduled,
subscription.canceled,
subscription.past_due,
refund_request.created,
payment.duplicate_detected,
payment.duplicate_refunded,
refund_request.declined
active
boolean
deprecated

Older spelling of isActive, still accepted.

Response

The updated endpoint.

id
string
required
Pattern: ^we_[0-9A-Za-z]{22}$
Example:

"we_3Tz8yU1oI4pA7sD0fG2hJk"

url
string<uri>
required

URL that receives deliveries.

events
string[]
required

Subscribed events. Any emitted event can be subscribed to by name, including ones without a documented payload yet.

isActive
boolean
required

Whether the endpoint is receiving deliveries.

createdAt
string<date-time>
required