Перейти к основному содержанию
POST
Пробное событие хука

Авторизации

tungo.session_token
string
cookie
обязательно

Сессия кабинета: cookie ставит вход через /v1/auth/* (Better Auth), браузер шлёт её сам — фронтенду кабинета ничего добавлять не нужно (fetch с credentials: 'include'). За HTTPS имя cookie — __Secure-tungo.session_token. Сессия кончилась — 401 authentication_error: отправить на вход.

Параметры пути

co
string
обязательно

id компании, co_… — из GET /v1/companies

id
string
обязательно

id хука (hk_…)

Пример:

"hk_01jz8x3m4n5p6q7r8s9t0v1w2x"

Тело

application/json

Пробное событие хука.

body
any
обязательно

Тело события, как его пришлёт отправитель: любое значение JSON (объект, массив, число…) — оно берётся как JSON-текст; строка — как сырой текст тела (так можно проверить и тело не-JSON). Не больше hook_body_max_bytes.

Пример:
content_type
string

Content-Type, с которым пришло бы событие (по умолчанию application/json) — сохраняется у пробного события и виден ИИ.

Maximum string length: 200
run
boolean

true — сохранить событие как пробное и поставить пробные запуски подошедшим включённым сценариям (ИИ вызывается и стоит как обычно; в 1С само ничего не пишется). Нет или false — только разбор: ничего не сохраняется, ИИ не вызывается, бесплатно.

Ответ

Разбор без запуска (run не передан или false)

Разбор пробного события хука.

hook_id
string
обязательно

Хук (hk_…)

Пример:

"hk_01jz8x3m4n5p6q7r8s9t0v1w2x"

signed
boolean
обязательно

true — хук требует подписи: настоящее событие без верной подписи получит 401. Здесь подпись не проверялась

signature_note
string
обязательно

Что с подписью у настоящих событий — словами

json
boolean
обязательно

Разобралось ли тело как JSON (фильтр видит только JSON)

external_id
string
обязательно

Номер операции, который взяла бы настоящая доставка (до 200 знаков)

Пример:

"PAY-1001"

external_id_source
enum<string>
обязательно

Откуда он взят: id_path — из поля тела по id_path хука; body_hash — sha256 тела (поля по id_path нет); у настоящей доставки без id_path первыми идут заголовки Idempotency-Key и X-Event-Id

Доступные опции:
id_path,
idempotency_key,
x_event_id,
body_hash
external_id_note
string
обязательно

То же словами: откуда настоящая доставка возьмёт номер операции

scenarios
object[]
обязательно

Сценарии с триггером этого хука и что с каждым

event_id
string | null
обязательно

Пробное событие (hev_…) — только при run: true; null — ничего не сохранено

run_ids
string[]
обязательно

Пробные запуски подошедших включённых сценариев (run: true); пусто без run

id запуска (run_…)