Ask for an invitation
Menu

Webhook event

webhook_endpoint.disabled

Deliveries to an endpoint failed for 7 days running and it was switched off. Sent to the merchant's other endpoints; the Owners are emailed.

Type
webhook_endpoint.disabled
The object it carries
the webhook_endpoint object
Subscribe with
webhook_endpoint.disabled, webhook_endpoint.* or *

Example payload

The body of the request your endpoint receives, shown here over several lines. On the wire it is compact JSON; check its signature over the bytes exactly as they arrive.

Example payload

{
  "id": "evt_9pvxwsxfq73nxxk17pwammf2",
  "object": "event",
  "livemode": true,
  "created": "2026-09-03T10:00:00.000Z",
  "type": "webhook_endpoint.disabled",
  "api_version": "2026-10-11",
  "data": {
    "object": {
      "id": "we_tx7j2vmn3r2px2vpwbtz5h7b",
      "object": "webhook_endpoint",
      "livemode": true,
      "created": "2026-09-03T10:00:00.000Z",
      "url": "https://acme.example/webhooks/orrerie",
      "description": "Shop backend",
      "enabled_events": [
        "order.paid",
        "order.underpaid",
        "order.overpaid",
        "order.expired",
        "refund.confirmed"
      ],
      "status": "disabled",
      "disabled_reason": "consecutive_failures",
      "api_version": "2026-10-11",
      "secret_last4": "k3Qw",
      "previous_secret_expires_at": null,
      "last_success_at": "2026-10-11T14:09:56.020Z",
      "last_failure_at": "2026-10-18T14:09:55.000Z",
      "metadata": {}
    },
    "previous_attributes": {
      "status": "enabled",
      "disabled_reason": null
    }
  },
  "request": {
    "id": null,
    "idempotency_key": null
  },
  "pending_webhooks": 1
}

Fields of data.object

Fields of data.object in webhook_endpoint.disabled
FieldIn this example
id"we_tx7j2vmn3r2px2vpwbtz5h7b"
object"webhook_endpoint"
livemodetrue
created"2026-09-03T10:00:00.000Z"
url"https://acme.example/webhooks/orrerie"
description"Shop backend"
enabled_eventsA list of 5 items
status"disabled"
disabled_reason"consecutive_failures"
api_version"2026-10-11"
secret_last4"k3Qw"
previous_secret_expires_atnull
last_success_at"2026-10-11T14:09:56.020Z"
last_failure_at"2026-10-18T14:09:55.000Z"
metadataAn object with no fields

What each field means is on the page of the webhook_endpoint object. data.previous_attributes holds the old values of exactly the fields that changed: here status, disabled_reason.

Endpoints behind it

Calls that change webhook endpoints. An event is also sent when a payer, the network, a timer or a person in the dashboard causes the change; the sentence above says which.