Webhook Events
A log of webhook deliveries. Each record is one event sent to one webhook, with the request body, the target's last response and the time of every attempt. Records are written by the platform; this API does not create, edit or delete them, but an undelivered event can be sent again (see Retrying an Event).
Superusers see every event; any other account sees only events of its own webhooks (see Visibility under Webhooks).
Webhook Event Fields
id
integer
The unique identifier of the record.
uuid
UUID
The event identifier, also sent as event.uuid in the request body (without hyphens).
webhook
object
The webhook the event was sent to, with all its fields.
request_payload
object
The JSON body that was sent.
response_http_status
integer
The status of the last attempt. 500 when the target could not be reached.
response_content
string
The body of the last response, or the error when the target could not be reached.
response_time
duration string or null
How long the last attempt took, as [DD ]HH:MM:SS.ffffff. null for events recorded before this field existed.
delivered
boolean
Whether an attempt received a 2xx response.
request_datetimes
array of date-time
When each attempt was made, newest first.
retry_count
integer or null
The number of attempts made.
content_type
integer or null
The content type of the object the event is about (for example the user).
object_id
string or null
The identifier of that object.
created_date, modified_date
date-time
When the event was recorded and last updated.
Filtering & Ordering
uuid
Exact
One event.
event_type
Exact, case-insensitive
The webhook's event type.
webhook
Exact
The webhook's id. An id that does not exist is rejected with 400.
delivered
true or false
false lists failed deliveries. Any other value is ignored.
response_http_status
Exact
For example 500.
content_type + object_id
Exact
Every event about one object: content_type is the object's content type id, object_id its identifier.
created_date, created_date__gt, created_date__gte, created_date__lt, created_date__lte
Date-time
A time window.
Filters can be combined; an event must satisfy all of them. Use the sort parameter to order the results by any event field (for example sort=-created_date). Without sort the order is not guaranteed, so pass one when paging through results.
Retrying an Event
POST /whisperer/hook_events/{id}/retry/ sends the event's stored request_payload to its webhook's current target_url once, immediately, and records the attempt on the same event: retry_count, request_datetimes, response_http_status, response_content, response_time and delivered are updated. No further automatic retries are scheduled.
Already delivered
406, event_100_3. Nothing is sent.
Undelivered, automatic retries still running (retry_count below 11)
406, event_100_6. Nothing is sent, unless the body is {"force": true}.
Undelivered, automatic retries finished, or force is true
The event is sent. 200 when the target answered 2xx, otherwise 406; both return the attempt's outcome.
Retrying requires the same model permission as other write operations; without it the request is refused with 403.
Last updated
Was this helpful?

