Каталог на събитията
Форма на данните
Раздел „Форма на данните“Всяко събитие е един 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 без втора схема.
Семейства събития
Раздел „Семейства събития“| Семейство | Примери | Кога се изпраща |
|---|---|---|
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 |
Всяко извикване на AI адаптер, с броя токени |
Точният списък расте заедно с продукта; екранът за абонаменти показва всеки тип, който акаунтът ви може да получава, и позволява филтриране по тип.
Абониране
Раздел „Абониране“Абонаментите за уебхукове принадлежат на плъгин. В Настройки → Плъгини отворете плъгина (или създайте собствен) и добавете крайна точка: HTTPS адрес, желаните типове събития и по избор списък с разрешени IP адреси. Тайната за подписване се показва веднъж. Доставките, повторните опити и недоставените съобщения за тази крайна точка се виждат в Журнала на уебхуковете на плъгина.
Протоколът за плъгини на страницата Плъгини описва как плъгинът декларира нужните му събития в манифеста си.
Ред и доставка
Раздел „Ред и доставка“- Доставката е поне веднъж. Премахвайте дубликатите по
id. - Събитията за един ресурс се изпращат по ред, но повторните опити могат да разместят доставките. Използвайте
occurred_atиupdated_atна ресурса вместо времето на пристигане. - Абонамент, който продължава да се проваля, натрупва недоставени съобщения; над 100 за една крайна точка предизвикват сигнал от страна на RolChat и предупреждение в журнала на плъгина.