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

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

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

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

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

Авторизация

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

Параметры

обязательный
string

Тело запроса

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

Authorization

headerAuthorizationBearer <token>

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

Path Parameters

id*string

Header Parameters

Typizer-Organization?string

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

Request Body

application/json
  1. body
url?string

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

Lengthlength <= 2048
events?array<>

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

Items1 <= items <= 16
status?string

active также сбрасывает failing_since

Value in"active""disabled"

Response Body

Конечная точка после изменения

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 PATCH 'https://api.typizer.ru/v1/webhook_endpoints/string' \  -H 'Content-Type: application/json' \  -d '{}'
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"}

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

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

Баланс страниц организации

Доступ: ключ API со скоупом billing:read или сессия.