Проверить доставку Webhook

POST

/api/v1/webhook/test

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

Поведение

Отправляет событие endpoint.test на сохранённый адрес обратного вызова — проверить подписи и ответ приёмника. Доставка асинхронная: HTTP 202 и возвращённый event_id означают лишь постановку в очередь, а не доставку. Результат смотрите в API деталей события.

Тест возможен только на сохранённый адрес — временные URL и произвольные payload не поддерживаются. При mode=off или глобальной паузе доставки возвращается 409.

Запись запрещена для удаленных ключей и ключей со scope. Отключенные, просроченные и исчерпанные ключи можно настраивать. Ограничение частоты общее с операциями записи жизненного цикла ключей: не более 10 запросов на запись в минуту на пользователя.

JSON не более 16384 байт, чтение тела не более 10 секунд. Параметры запроса, неизвестные и повторяющиеся поля JSON запрещены. Api_key_id обязателен.

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

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

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

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

api_key_idintegerтелообязательно

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

Недопустимый api_key_id — 400; отсутствующий или чужой ключ — 404; несохранённая или неполная конфигурация либо запрещённый тест — 409 (code=16015/16016); при лимите — 429.

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

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

curl --request POST \
  --url 'https://api.toapis.com/api/v1/webhook/test' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"api_key_id":123}'

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

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

{
  "code": 0,
  "message": "",
  "data": {
    "api_key_id": 123,
    "event_id": "evt_example"
  }
}

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