Documentation/webhook.endpoint.disabled

`webhook.endpoint.disabled`

A signed Boundry platform event. Its payload remains pinned to the API version configured for the receiving endpoint.

webhook.endpoint.disabled

Boundry disabled the endpoint after repeated failures.

Channel: webhook

Payload schema

FieldTypeDescription

api_versionrequiredstring

API version pinned to the webhook endpoint. Values: "2026-08-14". Default: "2026-08-14".

created_atrequiredstring (date-time)

Timestamp when Boundry created the event. Example: "2026-08-14T12:00:00.000Z".

datarequiredobject

Event resource wrapper. Example: {"object":{"created_at":"2026-08-14T12:00:00.000Z","disable_reason":"20 consecutive failed deliveries.","disabled_at":"2026-08-15T12:00:00.000Z","endpoint":"https://example.com/webhooks/boundry","events":["email.sent"],"id":"wh_01j0example","object":"webhook","status":"disabled"}}.

objectrequiredobject

Event resource. Example: {"created_at":"2026-08-14T12:00:00.000Z","disable_reason":"20 consecutive failed deliveries.","disabled_at":"2026-08-15T12:00:00.000Z","endpoint":"https://example.com/webhooks/boundry","events":["email.sent"],"id":"wh_01j0example","object":"webhook","status":"disabled"}.

api_versionrequiredstring

API version pinned to this endpoint. Values: "2026-08-14".

consecutive_failuresrequiredinteger

Consecutive delivery failures.

created_atrequiredstring (date-time)

Timestamp when the webhook was created. Example: "2026-08-14T12:00:00.000Z".

descriptionrequiredstring | null | null

Optional endpoint description.

Option 1string

Optional endpoint description.

Option 2null | null

One permitted response shape.

disable_reasonrequiredstring

Reason the endpoint was disabled. Example: "20 consecutive failed deliveries.".

disabled_atrequiredstring (date-time)

Timestamp when Boundry disabled the endpoint. Example: "2026-08-14T12:00:00.000Z".

endpointrequiredstring (uri)

Webhook delivery endpoint URL. Example: "https://hooks.acme.com/boundry".

eventsrequiredarray

Subscribed event types.

idrequiredstring

Webhook identifier. Example: "msg_01j0example".

last_failure_atrequiredstring (date-time) | null | null

Timestamp of the last failed delivery, or null.

Option 1string (date-time)

Timestamp of the last failed delivery.

Option 2null | null

One permitted response shape.

last_success_atrequiredstring (date-time) | null | null

Timestamp of the last successful delivery, or null.

Option 1string (date-time)

Timestamp of the last successful delivery.

Option 2null | null

One permitted response shape.

objectrequiredstring

Resource type discriminator. Values: "webhook".

secret_prefixrequiredstring

Non-secret signing-secret prefix. Example: "whsec_example".

statusrequiredstring

Webhook state. Values: "disabled".

updated_atrequiredstring (date-time)

Timestamp when the webhook was last updated. Example: "2026-08-14T12:00:00.000Z".

idrequiredstring

Stable event identifier.

livemoderequiredboolean

Whether the event originated in live mode.

objectrequiredstring

Resource type discriminator. Values: "event".

project_idrequiredstring

Owning project identifier. Example: "msg_01j0example".

typerequiredstring

Webhook event type. Values: "webhook.endpoint.disabled".

Sample body

webhook.endpoint.disabled event

json

{
  "api_version": "2026-08-14",
  "created_at": "2026-08-14T12:00:00.000Z",
  "data": {
    "object": {
      "created_at": "2026-08-14T12:00:00.000Z",
      "disable_reason": "20 consecutive failed deliveries.",
      "disabled_at": "2026-08-15T12:00:00.000Z",
      "endpoint": "https://example.com/webhooks/boundry",
      "events": [
        "email.sent"
      ],
      "id": "wh_01j0example",
      "object": "webhook",
      "status": "disabled"
    }
  },
  "id": "evt_01j0example",
  "livemode": true,
  "object": "event",
  "project_id": "proj_au_prod",
  "type": "webhook.endpoint.disabled"
}

Verify signed webhook deliveries →