A valid request URL is required to generate request examples{
"id": "<string>",
"object": "webhook_endpoint",
"merchant_id": "<string>",
"scope": "account",
"livemode": true,
"url": "<string>",
"description": "<string>",
"event_types": [
"<string>"
],
"api_version": "<string>",
"status": "active",
"disabled": true,
"created_at": 123,
"updated_at": 123,
"secret_last_rotated_at": 123,
"deleted_at": 123
}{
"error": {
"code": "INVALID_REQUEST",
"message": "url is required"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "WEBHOOK_ENDPOINT_NOT_FOUND",
"message": "webhook endpoint not found"
}
}{
"error": {
"code": "CONFLICT",
"message": "webhook endpoint was modified concurrently"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Update a webhook endpoint (PATCH)
Identical to POST /webhook_endpoints/{id}. Both methods route to the same
handler and accept the same body. PATCH is provided as an alias for clients
that prefer the standard HTTP verb for partial updates. Send an
Idempotency-Key header.
A valid request URL is required to generate request examples{
"id": "<string>",
"object": "webhook_endpoint",
"merchant_id": "<string>",
"scope": "account",
"livemode": true,
"url": "<string>",
"description": "<string>",
"event_types": [
"<string>"
],
"api_version": "<string>",
"status": "active",
"disabled": true,
"created_at": 123,
"updated_at": 123,
"secret_last_rotated_at": 123,
"deleted_at": 123
}{
"error": {
"code": "INVALID_REQUEST",
"message": "url is required"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "WEBHOOK_ENDPOINT_NOT_FOUND",
"message": "webhook endpoint not found"
}
}{
"error": {
"code": "CONFLICT",
"message": "webhook endpoint was modified concurrently"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
A merchant secret key (sk_…) sent as Authorization: Bearer <key>.
Headers
Required. A unique key that makes retries safe: the same key with the same request body returns the original response instead of repeating the operation.
255Path Parameters
The webhook endpoint id (whe_…).
Body
All fields are optional; omit any field to leave it unchanged.
New destination URL.
New description, or null to clear it.
Replacement set of event type subscriptions. Accepts the same wildcard forms as create.
true disables the endpoint; false re-enables it. Mutually exclusive with status.
Explicit status. active enables the endpoint; disabled pauses it. Mutually exclusive with disabled.
active, disabled Response
The updated webhook endpoint. The signing secret is not included.
Unique identifier for the webhook endpoint (whe_…).
webhook_endpoint ID of the account that owns the webhook endpoint (mer_…).
The immutable event stream delivered to this endpoint.
account, connected_accounts The HTTPS URL Ionic sends event payloads to.
Your label for the endpoint, or null if none is set.
Event types this endpoint receives, as exact types or wildcards.
API version that pins the event payload shape delivered to this endpoint.
Current lifecycle state. active means the endpoint is receiving deliveries.
disabled means it is paused by the merchant. deleted means it has been
soft-deleted. error means deliveries were disabled after repeated
failures.
active, disabled, deleted, error true when status is disabled; false otherwise.
Unix epoch seconds.
Unix epoch seconds when the endpoint was last updated.
Unix epoch seconds when the signing secret was last rotated. Null until the first rotation after creation.
Unix epoch seconds when the endpoint was deleted. Null while active.