> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/commerce-openapis/admin/webhooks/webhook-events.md).

# 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

| Field                           | Type                      | Description                                                                                                      |
| ------------------------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `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

| Parameter                                                                                        | Match                   | Notes                                                                                                     |
| ------------------------------------------------------------------------------------------------ | ----------------------- | --------------------------------------------------------------------------------------------------------- |
| `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.

| Event state                                                             | Result                                                                                                       |
| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| 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`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://apidocs.akinon.com/commerce-openapis/admin/webhooks/webhook-events.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
