Įvykių katalogas

Turinio forma

Kiekvienas įvykis yra vienas JSON objektas:

{
  "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 yra reikšmė antraštėje X-RolChat-Event-Id ir nesikeičia pakartojimų metu. type yra <domain>.<noun>.<verb> arba <domain>.<verb> snake_case formatu. data pateikia išteklių taip, kaip jį grąžintų atitinkamas GET galinis taškas, todėl gavėją galima parašyti pagal API žinyną ir niekada neprireiks antros schemos.

Įvykių šeimos

Šeima	Pavyzdžiai	Siunčiama, kai
conversation.*	conversation.created, conversation.assigned, conversation.resolved, conversation.reopened, conversation.merged	Pasikeičia pokalbio būsena ar atsakingasis
message.*	message.created, message.delivered, message.read, message.failed	Paskelbiama žinutė arba pasikeičia jos pristatymo būsena
crm.*	crm.lead.created, crm.contact.created, crm.contact.updated, crm.contact.merged, crm.deal.stage_changed, crm.deal.won	Pasikeičia potencialus klientas, kontaktas, įmonė ar sandoris
ticket.*	ticket.created, ticket.status_changed, ticket.assigned, ticket.sla_breached	Pasikeičia užklausa
visitor.*	visitor.identified, visitor.cobrowse.requested	Lankytojas atpažįstamas arba prašo bendro naršymo sesijos
marketing.*	marketing.form.submitted, marketing.booking.created, marketing.campaign.sent, marketing.unsubscribed	Formos, rezervacijos, kampanijos
kb.*	kb.article.published, kb.article.unpublished	Žinių bazės pakeitimai
phone.*	phone.call.started, phone.call.ended, phone.call.recorded, phone.call.transcribed, phone.voicemail.received	Skambučiai ir balso paštas
automation.*	automation.rule.executed, automation.rule.failed	Vykdoma automatizavimo taisyklė
privacy.*	privacy.consent.granted, privacy.consent.withdrawn, privacy.dsr.received	Sutikimai ir duomenų subjektų prašymai
billing.*	billing.invoice.created, billing.trial_expiring, billing.subscription.changed	Prenumerata ir sąskaitos
auth.*	auth.api_key.created, auth.api_key.revoked, auth.account.swapped	Saugumui svarbūs paskyros įvykiai
ai.*	ai.usage.recorded	Kiekvienas AI adapterio iškvietimas su žetonų skaičiumi

Tikslus sąrašas auga kartu su produktu; prenumeratos ekranas rodo kiekvieną tipą, kurį gali gauti jūsų paskyra, ir leidžia filtruoti pagal tipą.

Prenumerata

Webhook’ų prenumeratos priklauso įskiepiui. Skiltyje Nustatymai → Įskiepiai atidarykite įskiepį (arba sukurkite pasirinktinį) ir pridėkite galinį tašką: HTTPS URL, norimus įvykių tipus ir neprivalomą leidžiamų IP sąrašą. Pasirašymo paslaptis parodoma vieną kartą. To galinio taško pristatymai, pakartojimai ir neįteiktos žinutės rodomi įskiepio Webhook’ų žurnale.

Plugin Protocol puslapyje Įskiepiai aprašo, kaip įskiepis savo manifeste deklaruoja jam reikalingus įvykius.

Eiliškumas ir pristatymas

• Pristatymas vyksta bent vieną kartą. Dublikatus šalinkite pagal id.
• Vieno ištekliaus įvykiai siunčiami iš eilės, tačiau pakartojimai gali sukeisti pristatymų tvarką. Naudokite occurred_at ir ištekliaus updated_at, o ne atkeliavimo laiką.
• Nuolat nepavykstanti prenumerata kaupia neįteiktas žinutes; daugiau nei 100 vienam galiniam taškui sukelia įspėjimą RolChat pusėje ir rodo perspėjimą įskiepio žurnale.