События · Люди и доступ
api_key.expiring
Срок ключа API истекает
Срок действия ключа API истекает в течение 7 дней. Событие отправляется один раз на каждую дату истечения.
- Тип объекта
- api_key
- Кому доставляется
- Вебхукам с ролью администратора
Тело доставки
idstringобязательноID события (
evt_…), передаётся также в заголовкеwebhook-id. По нему отбрасывайте повторные доставки.typestringобязательноДопустимые значения:
api_key.expiringcreated_atstring (date-time)обязательноКогда произошло изменение (UTC).
org_idintegerобязательноapi_versionstringобязательноВерсия контракта схемы
data.sequenceintegerПорядковый номер доставки в пределах вебхука (нет у проверочного события).
payloadstringобязательноthin— безdata: читайте объект через API.Допустимые значения:
fullthindataobjectПоля
days_leftintegerобязательноСколько дней осталось до истечения ключа.
testbooleanобязательноПроверочное событие, отправленное
POST /v1/webhooks/{webhook_id}/test.
Пример доставки
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "api_key.expiring",
"created_at": "2026-10-24T10:00:03Z",
"org_id": 1,
"api_version": "1.62.0",
"sequence": 1042,
"object": {
"type": "api_key",
"id": "14"
},
"payload": "full",
"data": {
"api_key": {
"id": 14,
"name": "CRM sync",
"prefix": "kb_3f9a",
"kind": "org",
"role": "editor",
"scopes": [
"cards:read",
"cards:write"
],
"expires_at": "2026-10-31T00:00:00Z"
},
"days_left": 6
},
"test": false
}Получение событий
Каждая доставка — это POST-запрос с таким JSON-телом на адрес вашего вебхука. Прежде чем доверять телу, проверьте заголовок webhook-signature (Standard Webhooks), ответьте статусом 2xx в течение нескольких секунд, а саму работу выполняйте уже после ответа. Доставки на один адрес сохраняют порядок событий; неудачная доставка повторяется с нарастающими паузами.
Новые типы событий и новые поля могут появиться в любой момент: пропускайте типы и поля, которых не знаете.