Zum Inhalt springen

Ereigniskatalog

Jedes Ereignis ist ein JSON-Objekt:

{
"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 ist der Wert im Header X-RolChat-Event-Id und bleibt über Wiederholungen hinweg stabil. type hat die Form <domain>.<noun>.<verb> oder <domain>.<verb> in snake_case. data enthält die Ressource so, wie der entsprechende GET-Endpunkt sie liefern würde, sodass sich ein Empfänger anhand der API-Referenz schreiben lässt und nie ein zweites Schema braucht.

Gruppe Beispiele Ausgelöst, wenn
conversation.* conversation.created, conversation.assigned, conversation.resolved, conversation.reopened, conversation.merged Eine Konversation ihren Zustand oder ihre Zuständigkeit ändert
message.* message.created, message.delivered, message.read, message.failed Eine Nachricht veröffentlicht wird oder sich ihr Zustellstatus ändert
crm.* crm.lead.created, crm.contact.created, crm.contact.updated, crm.contact.merged, crm.deal.stage_changed, crm.deal.won Sich ein Lead, Kontakt, Unternehmen oder Deal ändert
ticket.* ticket.created, ticket.status_changed, ticket.assigned, ticket.sla_breached Sich ein Ticket ändert
visitor.* visitor.identified, visitor.cobrowse.requested Ein Besucher identifiziert wird oder eine Cobrowsing-Sitzung anfragt
marketing.* marketing.form.submitted, marketing.booking.created, marketing.campaign.sent, marketing.unsubscribed Formulare, Buchungen, Kampagnen
kb.* kb.article.published, kb.article.unpublished Änderungen in der Wissensdatenbank
phone.* phone.call.started, phone.call.ended, phone.call.recorded, phone.call.transcribed, phone.voicemail.received Anrufe und Mailbox
automation.* automation.rule.executed, automation.rule.failed Eine Automatisierungsregel ausgeführt wird
privacy.* privacy.consent.granted, privacy.consent.withdrawn, privacy.dsr.received Einwilligungen und Betroffenenanfragen
billing.* billing.invoice.created, billing.trial_expiring, billing.subscription.changed Abonnement und Rechnungen
auth.* auth.api_key.created, auth.api_key.revoked, auth.account.swapped Sicherheitsrelevante Kontoereignisse
ai.* ai.usage.recorded Jeder Aufruf eines KI-Adapters, mit Token-Anzahl

Die genaue Liste wächst mit dem Produkt; die Abonnementansicht zeigt jeden Typ, den Ihr Konto empfangen kann, und lässt Sie nach Typ filtern.

Webhook-Abonnements gehören zu einem Plugin. Öffnen Sie unter Einstellungen → Plugins das Plugin (oder erstellen Sie ein eigenes) und fügen Sie einen Endpunkt hinzu: HTTPS-URL, die gewünschten Ereignistypen und optional eine IP-Allowlist. Das Signaturgeheimnis wird einmal angezeigt. Zustellungen, Wiederholungen und Dead Letters für diesen Endpunkt erscheinen im Webhook-Protokoll des Plugins.

Das Plugin Protocol auf der Seite Plugins beschreibt, wie ein Plugin die benötigten Ereignisse in seinem Manifest deklariert.

  • Die Zustellung erfolgt mindestens einmal. Deduplizieren Sie nach id.
  • Ereignisse zu einer Ressource werden der Reihe nach versendet, Wiederholungen können die Reihenfolge der Zustellungen aber ändern. Verwenden Sie occurred_at und updated_at der Ressource statt der Ankunftszeit.
  • Ein Abonnement, das dauerhaft fehlschlägt, sammelt Dead Letters an; mehr als 100 für einen Endpunkt lösen auf Seiten von RolChat eine Warnung aus und zeigen einen Hinweis im Protokoll des Plugins.