Список событий Webhook

GET

/api/v1/webhook/events

Для пользователей из материкового Китая: используйте https://api.toapis.cn в качестве эндпоинта (Base URL). Замените https://api.toapis.com на https://api.toapis.cn во всех примерах этого документа.

Поведение

Возвращает журнал доставок webhook — для подтверждения доставки и диагностики сбоев. Без api_key_id возвращаются все события аккаунта. При указании проверяется, что это собственный обычный модельный ключ (мягко удалённые тоже годятся). По умолчанию — последние 24 часа.

from/to задаются парой, диапазон до 31 дня. limit по умолчанию 50, максимум 100, пагинация по внутреннему ID по убыванию. Курсор привязан к аккаунту и фильтрам — не меняйте фильтры между страницами.

Если на следующих страницах from/to опущены, используется диапазон, зафиксированный первым запросом, а не пересчитанный на момент перелистывания.

Аутентификация

Authorizationstringзаголовокобязательно

Используйте системный токен Bearer YOUR_SYSTEM_ACCESS_TOKEN. Доступ ограничен вашим аккаунтом. Ключи моделей не принимаются. X-User-Id не нужен. Обхода через права администратора или команды нет.

Параметры запроса

api_key_idintegerзапрос

Положительный целочисленный ID собственного обычного ключа модели, не секрет sk- и не токен доступа. Параметр запроса должен быть положительным целым; пропуск и null отклоняются.

task_idstringзапрос

ID задачи платформы.

statusstringзапрос

Статус доставки. pending/delivering/delivered/dead/cancelled.

fromstringзапрос

Время RFC 3339 с часовым поясом. from/to передаются вместе.

tostringзапрос

Время RFC 3339 с часовым поясом. from/to передаются вместе.

limitintegerзапрос

Размер страницы: 50 по умолчанию, максимум 100.

cursorstringзапрос

Курсор предыдущей страницы.

Недопустимые параметры — 400; отфильтрованный отсутствующий или чужой ключ — 404; при лимите — 429.

Примеры запросов

Пример запроса

curl --request GET \
  --url 'https://api.toapis.com/api/v1/webhook/events' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'

Примеры ответов

Пример ответа

{
  "code": 0,
  "message": "",
  "data": {
    "items": [
      {
        "event_id": "evt_example",
        "api_key_id": 123,
        "task_id": "example-task",
        "type": "generation.completed",
        "status": "delivered",
        "attempts": 1,
        "reason": "delivered",
        "last_http_status": 200,
        "created_at": "2026-11-13T00:00:00Z",
        "next_attempt_at": null,
        "delivered_at": "2026-11-13T00:00:01Z",
        "expires_at": "2026-11-14T12:00:00Z"
      }
    ],
    "has_more": false,
    "next_cursor": null,
    "meta": {
      "scope": "self",
      "from": "2026-11-12T01:00:00Z",
      "to": "2026-11-13T01:00:00Z",
      "consistency": "eventual"
    }
  }
}

Порядок подключения и проверку подписи см. в Получить настройки Webhook.