Skip to main content
PATCH
Update a webhook endpoint

Authorizations

Authorization
string
header
required

API key: Authorization: Bearer sk_test_... or sk_live_....

Headers

Invoice-Version
string

Pin a dated API release (Stripe-style). Omit to use the current version. An unknown value returns 400 request.invalid_version. Echoed back on every response.

Example:

"2026-07-10"

Invoice-Account
string

Connect: act on behalf of one of your connected accounts (its acct_…/org_… id). Omit to act as your own organization. Not honored on /v1/api_keys.

Example:

"org_2P9connectedacct"

Path Parameters

id
string
required

Webhook endpoint id, e.g. "we_2P9K3sample".

Body

application/json
url
string<uri>

New HTTPS delivery URL.

enabled_events
string[]

Replace the subscribed event types ("", "invoice.", or exact types).

Minimum array length: 1
disabled
boolean

true pauses delivery to this endpoint; false re-enables it.

metadata
object

Merge patch: keys with an empty-string value are removed; others are upserted.

Response

Default Response

object
enum<string>
required

Always "webhook_endpoint".

Available options:
webhook_endpoint
id
string
required

Webhook endpoint id, e.g. "we_2P9K3sample".

url
string
required

HTTPS URL events are delivered to.

enabled_events
string[]
required

Subscribed event types ("*", namespace wildcards, or exact types).

enabled
boolean
required

False when the endpoint is paused (disabled).

connect
boolean
required

True when this endpoint also receives connected-account events.

livemode
boolean
required

True if created with a live-mode key.

metadata
object
required

Integrator-owned key-value map echoed back.

created_at
string
required

Creation timestamp, ISO-8601 UTC.

updated_at
string
required

Last-update timestamp, ISO-8601 UTC.