Liigu sisu juurde

Sündmuste kataloog

Sisu kuju

Jaotis „Sisu kuju”

Iga sündmus on üks 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 on päise X-RolChat-Event-Id väärtus ja püsib korduskatsete vahel samana. type on kujul <domain>.<noun>.<verb> või <domain>.<verb> snake_case’is. data kannab ressurssi nii, nagu vastav GET-lõpp-punkt selle tagastaks, nii et vastuvõtja saab kirjutada API viite põhjal ega vaja kunagi teist skeemi.

Sündmuste perekonnad

Jaotis „Sündmuste perekonnad”
Perekond Näited Saadetakse, kui
conversation.* conversation.created, conversation.assigned, conversation.resolved, conversation.reopened, conversation.merged Vestluse olek või omanik muutub
message.* message.created, message.delivered, message.read, message.failed Sõnum postitatakse või selle edastusolek muutub
crm.* crm.lead.created, crm.contact.created, crm.contact.updated, crm.contact.merged, crm.deal.stage_changed, crm.deal.won Müügivihje, kontakt, ettevõte või tehing muutub
ticket.* ticket.created, ticket.status_changed, ticket.assigned, ticket.sla_breached Pilet muutub
visitor.* visitor.identified, visitor.cobrowse.requested Külastaja tuvastatakse või ta palub kaassirvimise seanssi
marketing.* marketing.form.submitted, marketing.booking.created, marketing.campaign.sent, marketing.unsubscribed Vormid, broneeringud, kampaaniad
kb.* kb.article.published, kb.article.unpublished Teadmusbaasi muudatused
phone.* phone.call.started, phone.call.ended, phone.call.recorded, phone.call.transcribed, phone.voicemail.received Kõned ja kõnepost
automation.* automation.rule.executed, automation.rule.failed Automatiseerimisreegel käivitub
privacy.* privacy.consent.granted, privacy.consent.withdrawn, privacy.dsr.received Nõusolek ja andmesubjekti taotlused
billing.* billing.invoice.created, billing.trial_expiring, billing.subscription.changed Tellimus ja arved
auth.* auth.api_key.created, auth.api_key.revoked, auth.account.swapped Turvalisuse seisukohalt olulised kontosündmused
ai.* ai.usage.recorded Iga AI-adapteri väljakutse koos tokenite arvuga

Täpne loend kasvab koos tootega; tellimuste ekraan näitab kõiki tüüpe, mida sinu konto saab vastu võtta, ja võimaldab filtreerida tüübi kaupa.

Tellimine

Jaotis „Tellimine”

Veebihaakide tellimused kuuluvad pistikprogrammile. Ava jaotises Seaded → Pistikprogrammid pistikprogramm (või loo kohandatud) ja lisa lõpp-punkt: HTTPS-URL, soovitud sündmuste tüübid ja valikuline IP-lubade loend. Allkirjastamise saladust näidatakse üks kord. Selle lõpp-punkti edastused, korduskatsed ja kohaletoimetamata sõnumid ilmuvad pistikprogrammi Veebihaakide logisse.

Plugin Protocol lehel Pistikprogrammid kirjeldab, kuidas pistikprogramm deklareerib oma manifestis vajalikud sündmused.

Järjekord ja edastamine

Jaotis „Järjekord ja edastamine”
  • Edastamine toimub vähemalt ühe korra. Eemalda duplikaadid id järgi.
  • Ühe ressursi sündmused saadetakse järjekorras, kuid korduskatsed võivad edastuste järjekorda muuta. Kasuta saabumisaja asemel väärtust occurred_at ja ressursi updated_at.
  • Pidevalt ebaõnnestuv tellimus kogub kohaletoimetamata sõnumeid; üle 100 ühe lõpp-punkti kohta tekitab RolChati poolel hoiatuse ja näitab pistikprogrammi logis hoiatust.