A webhook endpoint was disabled

POST

Sent to the store’s other subscribed endpoints when one answered 410 or kept failing for five days.

Request Body^required

Media typeapplication/json

WebhookEvent_WebhookDisabled_

object

api_version

Api Version

The payload version

string

default: v1

Allowed value: v1

created

required

Created

When the event happened

string format: date-time

data

required

WebhookData_WebhookDisabled_

The event’s object

object

object

required

WebhookDisabled

The topic’s object

object

disabled_at

required

Disabled At

When it was disabled

string format: date-time

endpoint_id

required

Endpoint Id

The endpoint disabled

string

/^whe_[0-9a-f]{32}$/

reason

required

Reason

Gone: it answered 410 | failing_five_days: it kept failing for five days

string

id

required

Id

The event id, also sent as the webhook-id header; deduplicate on it

string

/^evt_[0-9a-f]{32}$/

type

required

Type

The topic: quiz.started | quiz.finished | quiz.abandoned | identity.captured | quiz.published | experiment.started | experiment.ended | profile.created | profile.updated | export.completed | webhook.endpoint.disabled | ping

string

Responses

200

Any 2xx within 10 seconds acknowledges the event

4XX

410 ends the delivery and disables the endpoint; any other 4xx but 408 and 429 ends it

5XX

Retried, as are 408, 429, a timeout and a network error: seven retries over about 28 hours, then the delivery is dead