Webhooks
A webhook endpoint is a URL of yours that receives signed events: finished moderations, review queue decisions, executed actions and author changes. Events and deliveries are kept for 30 days.
Endpoints
- GET/v1/webhooksList endpoints
- POST/v1/webhooksCreate an endpoint
- GET/v1/webhooks/eventsList events
- GET/v1/webhooks/{id}Retrieve an endpoint
- PATCH/v1/webhooks/{id}Update an endpoint
- DELETE/v1/webhooks/{id}Delete an endpoint
- POST/v1/webhooks/{id}/rotate_secretRotate the secret
- GET/v1/webhooks/{id}/deliveriesList deliveries
- POST/v1/webhooks/deliveries/{id}/replayReplay a delivery
The webhook endpoint object
A URL of yours that receives the project's events as signed POST requests.
{
"object": "webhook_endpoint",
"id": "whe_2HLyVEWQelwo16welH16NM",
"project_id": "prj_0TBAgHGtdMketrbltGFHuk",
"url": "https://example.com/webhooks/infrared",
"description": "Marketplace backend",
"event_types": ["moderation.completed", "queue_item.created"],
"status": "active",
"api_version": "2026-09-01",
"consecutive_failures": 0,
"disabled_at": null,
"disabled_reason": null,
"last_delivery_at": "2026-10-08T09:29:11.086Z",
"last_success_at": "2026-10-08T09:29:11.086Z",
"created_at": "2026-10-08T09:28:59.023Z",
"updated_at": "2026-10-08T09:29:11.086Z"
}Attributes
object"webhook_endpoint"Always
webhook_endpoint.idstringId of the endpoint:
whe_plus 22 base62 characters.urlURLThe URL events are delivered to.
descriptionstring or nullA note on what the endpoint is for, or null.
event_typesarray of enumsThe event types the endpoint receives. An empty array means every event.
One of
moderation.completedmoderation.failedqueue_item.createdqueue_item.allowedqueue_item.rejectedqueue_item.actionedqueue_item.reopenedauthor.blockedauthor.suspendedauthor.enabledauthor.trust_level_changedaction.executedstatusenumactive: receives events.disabled: receives nothing, set by you or by Infrared after 50 failed delivery attempts in a row.One of
activedisabledapi_versionstringVersion of the event payloads the endpoint receives, a date such as
2026-09-01.consecutive_failuresintegerFailed delivery attempts in a row. A success or re-enabling the endpoint resets it to 0. At 50 the endpoint is disabled and the organisation's owners and admins are emailed.
secretstringThe signing secret:
whsec_plus 40 characters. Present only in the responses to creating an endpoint and to rotating its secret.project_idstringId of the project:
prj_plus 22 base62 characters.disabled_atWhen the endpoint was disabled, or null.
disabled_reasonmanualwhen you disabled the endpoint, or a text such as50 consecutive failureswhen Infrared did. Null while active.last_delivery_attimestampWhen the last delivery attempt was made, or null.
last_success_attimestampWhen the endpoint last answered 2xx, or null.
created_attimestampWhen the endpoint was created, ISO 8601 in UTC.
updated_attimestampWhen the endpoint last changed, ISO 8601 in UTC.
Something missing or unclear on this page? Write to support@useinfrared.com.