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

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

Создать конечную точку вебхуков

Одна конечная точка на URL: URL, который у организации уже есть (в том числе созданный для webhook_url прогона или отключённый), — 409; вместо этого измените ту конечную точку. Не больше 50 активных конечных точек на организацию, включая созданные для прогонов (409). Доставки подписываются по Standard Webhooks (webhook-id, webhook-timestamp, webhook-signature) секретом конечной точки (secret). Поддерживает Idempotency-Key (в ответе-повторе secret: null). Доступ: ключ API со скоупом runs:write или сессия.

POST/v1/webhook_endpointsПесочница

Авторизация

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

Тело запроса

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

Authorization

headerAuthorizationBearer <token>

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

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

Request Body

application/json
  1. body
url*string

Публичный URL https: (без имени пользователя и пароля; IP-адрес должен быть публичным). Хост разрешается и проверяется заново при каждой доставке.

Lengthlength <= 2048
events*array<>

События, которые получает конечная точка: непустое подмножество; повторы отбрасываются

Items1 <= items <= 16

Response Body

Создана, с её secret

application/json
  1. response
id*string
object*"webhook_endpoint"
Value in"webhook_endpoint"
url*string
events*array<>

События по подписке. У конечной точки, созданной для webhook_url прогона, подписок сначала нет: она получает только события таких прогонов.

status*string

disabled — ничего не получает. Конечная точка, доставки на которую не удаются 72 часа, отключается.

Value in"active""disabled"
secret*|

Секрет подписи (whsec_…, Standard Webhooks). Показывается ключу или сессии со скоупом runs:write; иначе null, как и в ответе-повторе по Idempotency-Key.

failing_since*|
Formatdate-time
created_at*string
Formatdate-time
curl -X POST 'https://api.typizer.ru/v1/webhook_endpoints' \  -H 'Content-Type: application/json' \  -d '{  "url": "string",  "events": [    "run.succeeded"  ]}'
Example Response
{  "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"}