Перейти к основному содержанию
WEBHOOK

Заголовки

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

id сообщения (msg_…): один на все попытки доставки этого сообщения; входит в подписанную строку

Пример:

"msg_2xyzExample"

webhook-timestamp
string
обязательно

Время этой попытки, секунды Unix; входит в подписанную строку

Пример:

"1793974568"

webhook-signature
string
обязательно

Подписи через пробел, каждая вида v1,base64 (порядок проверки — в описании события)

Пример:

"v1,kD9WhUZS+K/OigYAsDOosIiagX7cTfjEkMl9fxCJ4GI="

Тело

application/json

Срок ключа API скоро кончится: за 14 и за 3 дня (настройка платформы api_keys.expiry_reminder_days), по одному разу на порог. Продлить — PATCH ключа с expires_at или смена секрета (roll). Автору ключа уходит и письмо.

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

id события — тот же при повторной доставке: по нему отбрасывайте повторы (evt_…)

Pattern: ^evt_[0-9a-z]{26}$
type
enum<string>
обязательно

Вид события

Доступные опции:
api_key.expiring
created_at
string<date-time>
обязательно

Когда событие случилось

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

Организация (ws_…)

Pattern: ^ws_[0-9a-z]{26}$
company_id
string | null
обязательно

Компания; null — событие организации (например, оплата) (co_…)

Pattern: ^co_[0-9a-z]{26}$
data
object
обязательно

Данные события — только id, суммы, токены, статусы и время, без персональных данных

Ответ

200

Любой ответ 2xx — событие доставлено. Иной ответ или нет ответа за 30 секунд — повтор по расписанию