Создать конечную точку вебхуков
Одна конечная точка на URL: URL, который у организации уже есть (в том числе созданный для webhook_url прогона или отключённый), — 409; вместо этого измените ту конечную точку. Не больше 50 активных конечных точек на организацию, включая созданные для прогонов (409). Доставки подписываются по Standard Webhooks (webhook-id, webhook-timestamp, webhook-signature) секретом конечной точки (secret). Поддерживает Idempotency-Key (в ответе-повторе secret: null). Доступ: ключ API со скоупом runs:write или сессия.
AuthorizationBearer <token>Ключ API (tz_live_…). Если операция требует скоупы, они нужны ключу; у сессии есть все скоупы.
Typizer-Organization?stringОрганизация, от имени которой выполняется запрос (org_…). По умолчанию сессия действует от имени своей активной организации; ключ API может указать только свою.
Idempotency-Key?string1–255 печатных символов ASCII, уникальных для каждой задуманной операции. Повтор с тем же ключом и тем же запросом в течение 24 часов возвращает первый результат (Idempotent-Replayed: true); тот же ключ с другим запросом или пока первый ещё выполняется — 409 idempotency_conflict.
^[\x20-\x7E]+$1 <= length <= 255application/json- body
url*stringПубличный URL https: (без имени пользователя и пароля; IP-адрес должен быть публичным). Хост разрешается и проверяется заново при каждой доставке.
length <= 2048events*array<>События, которые получает конечная точка: непустое подмножество; повторы отбрасываются
1 <= items <= 16Создана, с её secret
application/json- response
id*stringobject*"webhook_endpoint""webhook_endpoint"url*stringevents*array<>События по подписке. У конечной точки, созданной для webhook_url прогона, подписок сначала нет: она получает только события таких прогонов.
status*stringdisabled — ничего не получает. Конечная точка, доставки на которую не удаются 72 часа, отключается.
"active""disabled"secret*|Секрет подписи (whsec_…, Standard Webhooks). Показывается ключу или сессии со скоупом runs:write; иначе null, как и в ответе-повторе по Idempotency-Key.
failing_since*|date-timecreated_at*stringdate-timecurl -X POST 'https://api.typizer.ru/v1/webhook_endpoints' \ -H 'Content-Type: application/json' \ -d '{ "url": "string", "events": [ "run.succeeded" ]}'{ "id": "string", "object": "webhook_endpoint", "url": "string", "events": [ "run.succeeded" ], "status": "active", "secret": "string", "failing_since": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z"}