Přeskočit na obsah

Katalog událostí

Každá událost je jeden objekt 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 je hodnota z hlavičky X-RolChat-Event-Id a při opakováních se nemění. type má tvar <domain>.<noun>.<verb> nebo <domain>.<verb> ve snake_case. data nese zdroj tak, jak by ho vrátil odpovídající endpoint GET, takže příjemce lze napsat podle reference API a nikdy nepotřebuje druhé schéma.

Rodina Příklady Posílá se, když
conversation.* conversation.created, conversation.assigned, conversation.resolved, conversation.reopened, conversation.merged Konverzace změní stav nebo vlastníka
message.* message.created, message.delivered, message.read, message.failed Zpráva je odeslána nebo se změní stav jejího doručení
crm.* crm.lead.created, crm.contact.created, crm.contact.updated, crm.contact.merged, crm.deal.stage_changed, crm.deal.won Změní se lead, kontakt, firma nebo obchod
ticket.* ticket.created, ticket.status_changed, ticket.assigned, ticket.sla_breached Změní se tiket
visitor.* visitor.identified, visitor.cobrowse.requested Návštěvník je identifikován nebo požádá o společné prohlížení
marketing.* marketing.form.submitted, marketing.booking.created, marketing.campaign.sent, marketing.unsubscribed Formuláře, rezervace, kampaně
kb.* kb.article.published, kb.article.unpublished Změny ve znalostní bázi
phone.* phone.call.started, phone.call.ended, phone.call.recorded, phone.call.transcribed, phone.voicemail.received Hovory a hlasová schránka
automation.* automation.rule.executed, automation.rule.failed Spustí se pravidlo automatizace
privacy.* privacy.consent.granted, privacy.consent.withdrawn, privacy.dsr.received Souhlasy a žádosti subjektů údajů
billing.* billing.invoice.created, billing.trial_expiring, billing.subscription.changed Předplatné a faktury
auth.* auth.api_key.created, auth.api_key.revoked, auth.account.swapped Bezpečnostně významné události účtu
ai.* ai.usage.recorded Každé volání adaptéru AI, s počty tokenů

Přesný seznam roste s produktem; obrazovka odběru ukazuje každý typ, který může váš účet přijímat, a umožňuje filtrovat podle typu.

Odběry webhooků patří k pluginu. V Nastavení → Pluginy otevřete plugin (nebo vytvořte vlastní) a přidejte endpoint: URL s HTTPS, požadované typy událostí a volitelný seznam povolených IP. Podpisový tajný klíč se zobrazí jen jednou. Doručení, opakování a nedoručitelné zprávy pro tento endpoint se objeví v Logu webhooků pluginu.

Plugin Protocol na stránce Pluginy popisuje, jak plugin v manifestu deklaruje události, které potřebuje.

Pořadí a doručování

Sekce “Pořadí a doručování”
  • Doručování probíhá alespoň jednou. Deduplikujte podle id.
  • Události jednoho zdroje se odesílají v pořadí, ale opakování mohou pořadí doručení změnit. Používejte occurred_at a updated_at zdroje místo času doručení.
  • Odběr, který stále selhává, hromadí nedoručitelné zprávy; víc než 100 pro jeden endpoint vyvolá upozornění na straně RolChat a varování v logu pluginu.