Gå til innholdet

Hendelseskatalog

Nyttelastformat

Section titled “Nyttelastformat”

Hver hendelse er ett 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 er verdien i headeren X-RolChat-Event-Id og er stabil på tvers av nye forsøk. type er <domain>.<noun>.<verb> eller <domain>.<verb> i snake_case. data inneholder ressursen slik det tilsvarende GET-endepunktet ville returnert den, så en mottaker kan skrives mot API-referansen og trenger aldri et eget skjema.

Hendelsesfamilier

Section titled “Hendelsesfamilier”
Familie Eksempler Sendes når
conversation.* conversation.created, conversation.assigned, conversation.resolved, conversation.reopened, conversation.merged En samtale endrer tilstand eller eierskap
message.* message.created, message.delivered, message.read, message.failed En melding publiseres, eller leveringsstatusen endres
crm.* crm.lead.created, crm.contact.created, crm.contact.updated, crm.contact.merged, crm.deal.stage_changed, crm.deal.won Et lead, en kontakt, et selskap eller en avtale endres
ticket.* ticket.created, ticket.status_changed, ticket.assigned, ticket.sla_breached En sak endres
visitor.* visitor.identified, visitor.cobrowse.requested En besøkende identifiseres eller ber om en samlesingsøkt
marketing.* marketing.form.submitted, marketing.booking.created, marketing.campaign.sent, marketing.unsubscribed Skjemaer, bookinger, kampanjer
kb.* kb.article.published, kb.article.unpublished Endringer i kunnskapsbasen
phone.* phone.call.started, phone.call.ended, phone.call.recorded, phone.call.transcribed, phone.voicemail.received Samtaler og talepost
automation.* automation.rule.executed, automation.rule.failed En automatiseringsregel kjører
privacy.* privacy.consent.granted, privacy.consent.withdrawn, privacy.dsr.received Samtykke og forespørsler fra registrerte
billing.* billing.invoice.created, billing.trial_expiring, billing.subscription.changed Abonnement og fakturaer
auth.* auth.api_key.created, auth.api_key.revoked, auth.account.swapped Sikkerhetsrelevante kontohendelser
ai.* ai.usage.recorded Hvert kall til en AI-adapter, med antall tokener

Den nøyaktige listen vokser med produktet; abonnementsskjermbildet viser alle typer kontoen din kan motta, og lar deg filtrere per type.

Abonnere

Section titled “Abonnere”

Webhook-abonnementer tilhører en plugin. I Innstillinger → Plugins åpner du pluginen (eller oppretter en egendefinert) og legger til et endepunkt: HTTPS-URL, hendelsestypene du vil ha, og en valgfri tillatelsesliste over IP-adresser. Signeringshemmeligheten vises én gang. Leveranser, nye forsøk og døde meldinger for endepunktet vises i pluginens Webhook-logg.

Plugin Protocol på siden Plugins beskriver hvordan en plugin angir hendelsene den trenger, i manifestet sitt.

Rekkefølge og levering

Section titled “Rekkefølge og levering”
  • Levering skjer minst én gang. Fjern duplikater etter id.
  • Hendelser for én ressurs sendes i rekkefølge, men nye forsøk kan endre rekkefølgen på leveransene. Bruk occurred_at og ressursens updated_at i stedet for ankomsttidspunktet.
  • Et abonnement som stadig feiler, samler opp døde meldinger; mer enn 100 for ett endepunkt utløser et varsel hos RolChat og viser en advarsel i pluginens logg.