Необходимые cookie-файлы нужны для работы сайта. Аналитические cookie (Яндекс Метрика) — только с вашего согласия. Политика cookie-файлов

Тема оформления
СправочникСправочник APIВебхуки

Отправить тестовое событие на конечную точку

Событие run.succeeded с примером прогона (run_test, output: {"example": true}) только на эту конечную точку; повторяется, как любая доставка. Отключённая конечная точка — 409. Тесты и повторы: 20 в минуту на организацию (429). Поддерживает Idempotency-Key. Доступ: ключ API со скоупом runs:write или сессия.

Claude (откроется в новой вкладке)ChatGPT (откроется в новой вкладке)
POST/v1/webhook_endpoints/{id}/testПесочница

Авторизация

Проверяем сессию Кабинета…

Параметры

обязательный
string
Проверяем сессию Кабинета…

Authorization

headerAuthorizationBearer <token>

Ключ API (tz_live_…). Если операция требует скоупы, они нужны ключу; у сессии есть все скоупы.

Path Parameters

id*string

Header Parameters

Typizer-Organization?string

Организация, от имени которой выполняется запрос (org_…). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.

Idempotency-Key?string

1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (Idempotent-Replayed: true); тот же ключ с другим запросом или пока первый ещё выполняется — 409 idempotency_conflict.

Match^[\x20-\x7E]+$
Length1 <= length <= 255

Response Body

Доставка

application/json
  1. response
id*string
object*"webhook_delivery"
Value in"webhook_delivery"
event_id*string
event_type*string
status*string
Value in"pending""succeeded""failed"
attempt*integer

Номер текущей или следующей попытки, с 0. Неудачные попытки повторяются через 5 с, 5 мин, 30 мин, 2 ч, 5 ч и 10 ч (попытки 0–6); после последней доставка получает статус failed. Ручной повтор — ещё одна попытка.

response_code*|

HTTP-статус последней попытки; null до первой попытки или если ответ не пришёл

next_attempt_at*|
Formatdate-time
created_at*string
Formatdate-time
curl -X POST 'https://api.typizer.ru/v1/webhook_endpoints/string/test'
Example Response
{  "id": "string",  "object": "webhook_delivery",  "event_id": "string",  "event_type": "string",  "status": "pending",  "attempt": 0,  "response_code": 0,  "next_attempt_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}

Повторить неудачную доставку один раз

Только доставка в статусе failed у активной конечной точки (иначе 409). Ещё одна попытка, сейчас; если она не удалась, доставка снова failed (без новых автоматических повторов). Тесты и повторы: 20 в минуту на организацию (429). Поддерживает Idempotency-Key. Доступ: ключ API со скоупом runs:write или сессия.

Изменить конечную точку вебхуков

url, который уже есть у другой конечной точки организации, — 409; повторное включение конечной точки сверх лимита активных — 409. Доступ: ключ API со скоупом runs:write или сессия.