A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"plane": "product",
"description": "<string>",
"subscribed_events": [
"<string>"
],
"status": "enabled",
"consecutive_failures": 123,
"disabled_at": "2023-11-07T05:31:56Z",
"disabled_reason": "<string>",
"recent_failures": 123,
"created_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Update a webhook endpoint
Requires webhooks:manage, plus audit:deliver when the endpoint is on the audit plane — re-aiming or disabling it decides where a compliance record goes. plane is not a field here: an endpoint stays on the plane it was registered on. Every other field is optional; what is absent is left alone. Setting status back to enabled clears the failure streak, so an endpoint you just repaired starts its next auto-disable from zero.
A valid request URL is required to generate request examples{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"plane": "product",
"description": "<string>",
"subscribed_events": [
"<string>"
],
"status": "enabled",
"consecutive_failures": 123,
"disabled_at": "2023-11-07T05:31:56Z",
"disabled_reason": "<string>",
"recent_failures": 123,
"created_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Cabeçalhos
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Parâmetros de caminho
The webhook endpoint's id.
Corpo
Resposta
Updated.
Where deliveries are POSTed. https:// only.
Which fan-out feeds this endpoint. product is the event catalogue, filtered by subscribed_events. audit is the staff audit trail — every action somebody in the panel performed, with the actor on the body. Set when the endpoint is registered and never afterwards: moving an endpoint between planes would be a way around the permission and the plan that guard the second one.
product, audit Types from the published catalogue. Empty means every deliverable event — a new type then starts arriving without anything being changed here.
disabled is either your decision or the auto-disable after sustained failure. A disabled endpoint is queued nothing.
enabled, disabled Deliveries that spent every attempt, back to back. Any success resets it.
Deliveries that gave up in the last 24 hours.