Перейти до вмісту

Каталог подій

Форма даних

Section titled “Форма даних”

Кожна подія - це один JSON-об’єкт:

{
  "id": "evt_01HKQN9…",
  "type": "conversation.created",
  "occurred_at": "2026-04-20T14:23:45.123Z",
  "account_id": "7c1d2c6e-…",
  "site_id": "0f3a…",
  "data": { … the resource, in the same shape the API returns it … }
}

id - це значення із заголовка X-RolChat-Event-Id, воно не змінюється між повторами. type має вигляд <domain>.<noun>.<verb> або <domain>.<verb> у snake_case. data містить ресурс у тому вигляді, у якому його повернув би відповідний ендпоінт GET, тож приймач можна писати за довідником API без окремої схеми.

Сімейства подій

Section titled “Сімейства подій”
Сімейство Приклади Коли надсилається
conversation.* conversation.created, conversation.assigned, conversation.resolved, conversation.reopened, conversation.merged Діалог змінює стан або відповідального
message.* message.created, message.delivered, message.read, message.failed Публікується повідомлення або змінюється статус його доставки
crm.* crm.lead.created, crm.contact.created, crm.contact.updated, crm.contact.merged, crm.deal.stage_changed, crm.deal.won Змінюється лід, контакт, компанія чи угода
ticket.* ticket.created, ticket.status_changed, ticket.assigned, ticket.sla_breached Змінюється тікет
visitor.* visitor.identified, visitor.cobrowse.requested Відвідувача ідентифіковано або він запитує сеанс спільного перегляду
marketing.* marketing.form.submitted, marketing.booking.created, marketing.campaign.sent, marketing.unsubscribed Форми, бронювання, кампанії
kb.* kb.article.published, kb.article.unpublished Зміни в базі знань
phone.* phone.call.started, phone.call.ended, phone.call.recorded, phone.call.transcribed, phone.voicemail.received Дзвінки та голосова пошта
automation.* automation.rule.executed, automation.rule.failed Виконується правило автоматизації
privacy.* privacy.consent.granted, privacy.consent.withdrawn, privacy.dsr.received Згоди та запити суб’єктів даних
billing.* billing.invoice.created, billing.trial_expiring, billing.subscription.changed Підписка та рахунки
auth.* auth.api_key.created, auth.api_key.revoked, auth.account.swapped Важливі для безпеки події акаунта
ai.* ai.usage.recorded Кожен виклик ШІ-адаптера, з кількістю токенів

Точний список зростає разом із продуктом; екран підписки показує всі типи, які може отримувати ваш акаунт, і дає змогу фільтрувати за типом.

Підписка

Section titled “Підписка”

Підписки на вебхуки належать плагіну. У розділі Налаштування → Плагіни відкрийте плагін (або створіть власний) і додайте ендпоінт: HTTPS-адресу, потрібні типи подій і, за бажання, список дозволених IP. Секрет для підпису показується один раз. Доставки, повтори та недоставлені повідомлення для цього ендпоінта відображаються в Журналі вебхуків плагіна.

Протокол плагінів на сторінці Плагіни описує, як плагін оголошує потрібні йому події у своєму маніфесті.

Порядок і доставка

Section titled “Порядок і доставка”
  • Доставка виконується щонайменше один раз. Дедуплікуйте за id.
  • Події одного ресурсу надсилаються по черзі, але повтори можуть змінити порядок доставок. Спирайтеся на occurred_at і updated_at ресурсу, а не на час отримання.
  • Підписка, яка постійно завершується помилкою, накопичує недоставлені повідомлення; понад 100 для одного ендпоінта викликають сповіщення на боці RolChat і попередження в журналі плагіна.