Skip to navigation

Webhook staled

Emitted when a webhook subscription is staled.

We mark a subscription as staled and automatically stop sending events to the webhook if the success rate for the last 6 hours is below 90%.

After fixing the issue, you must patch the webhook changing the status to active. If the success rate is still below 90%, the webhook will be marked as stale again.

Payload

The payload of this webhook request is an object.
versionstringRequiredformat: "^\d+\.\d+$"
Version of the schema used for this event
datalist of objectsRequired
The event payload, with one or more records of the specified type
webhook_idstringRequiredformat: "uuid"
Unique identifier for the webhook subscription that triggered this delivery
event_namestringOptionalDefaults to webhook.staled
timestampdatetime or nullOptional
ISO 8601 timestamp when the event occurred
idstring or nullOptionalformat: "uuid"

Unique identifier for this specific event instance (UUID v7 for time-ordered sorting)

delivery_attemptintegerOptionalDefaults to 0
The number of times the event has been attempted to be delivered

Response

200
Successful Response
422
Validation Error