Przejdź do głównej zawartości

Katalog zdarzeń

Każde zdarzenie to jeden obiekt 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 to wartość z nagłówka X-RolChat-Event-Id, stała przy ponowieniach. type ma postać <domain>.<noun>.<verb> lub <domain>.<verb> w snake_case. data zawiera zasób w takiej postaci, w jakiej zwróciłby go odpowiedni endpoint GET, więc odbiorcę można napisać na podstawie dokumentacji API i nigdy nie potrzebuje drugiego schematu.

Rodzina Przykłady Wysyłane, gdy
conversation.* conversation.created, conversation.assigned, conversation.resolved, conversation.reopened, conversation.merged Rozmowa zmienia stan lub właściciela
message.* message.created, message.delivered, message.read, message.failed Wiadomość zostaje opublikowana lub zmienia się jej status dostarczenia
crm.* crm.lead.created, crm.contact.created, crm.contact.updated, crm.contact.merged, crm.deal.stage_changed, crm.deal.won Zmienia się lead, kontakt, firma lub transakcja
ticket.* ticket.created, ticket.status_changed, ticket.assigned, ticket.sla_breached Zmienia się zgłoszenie
visitor.* visitor.identified, visitor.cobrowse.requested Odwiedzający zostaje zidentyfikowany lub prosi o sesję współprzeglądania
marketing.* marketing.form.submitted, marketing.booking.created, marketing.campaign.sent, marketing.unsubscribed Formularze, rezerwacje, kampanie
kb.* kb.article.published, kb.article.unpublished Zmiany w bazie wiedzy
phone.* phone.call.started, phone.call.ended, phone.call.recorded, phone.call.transcribed, phone.voicemail.received Połączenia i poczta głosowa
automation.* automation.rule.executed, automation.rule.failed Wykonuje się reguła automatyzacji
privacy.* privacy.consent.granted, privacy.consent.withdrawn, privacy.dsr.received Zgody i wnioski osób, których dane dotyczą
billing.* billing.invoice.created, billing.trial_expiring, billing.subscription.changed Subskrypcja i faktury
auth.* auth.api_key.created, auth.api_key.revoked, auth.account.swapped Istotne dla bezpieczeństwa zdarzenia konta
ai.* ai.usage.recorded Każde wywołanie adaptera AI, z liczbą tokenów

Dokładna lista rośnie razem z produktem; ekran subskrypcji pokazuje każdy typ, który Twoje konto może otrzymywać, i pozwala filtrować według typu.

Subskrypcje webhooków należą do wtyczki. W Ustawienia → Wtyczki otwórz wtyczkę (lub utwórz własną) i dodaj endpoint: URL HTTPS, wybrane typy zdarzeń i opcjonalną listę dozwolonych IP. Sekret podpisujący jest pokazywany raz. Dostarczenia, ponowienia i martwe wiadomości dla tego endpointu pojawiają się w Logu webhooków wtyczki.

Plugin Protocol na stronie Wtyczki opisuje, jak wtyczka deklaruje w manifeście potrzebne jej zdarzenia.

  • Dostarczanie działa w trybie co najmniej raz. Deduplikuj według id.
  • Zdarzenia dotyczące jednego zasobu są wysyłane po kolei, ale ponowienia mogą zmienić kolejność dostarczeń. Używaj occurred_at i updated_at zasobu zamiast czasu przybycia.
  • Subskrypcja, która stale zawodzi, gromadzi martwe wiadomości; ponad 100 dla jednego endpointu wywołuje alert po stronie RolChat i ostrzeżenie w logu wtyczki.