Pāriet uz saturu

Notikumu katalogs

Satura forma

Section titled “Satura forma”

Katrs notikums ir viens JSON objekts:

{
  "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 ir vērtība galvenē X-RolChat-Event-Id, un tā nemainās atkārtojumos. type ir <domain>.<noun>.<verb> vai <domain>.<verb> snake_case formātā. data satur resursu tādu, kādu to atgrieztu atbilstošais GET galapunkts, tāpēc saņēmēju var rakstīt pēc API atsauces, un otra shēma nekad nav vajadzīga.

Notikumu saimes

Section titled “Notikumu saimes”
Saime Piemēri Tiek sūtīts, kad
conversation.* conversation.created, conversation.assigned, conversation.resolved, conversation.reopened, conversation.merged Mainās sarunas stāvoklis vai atbildīgais
message.* message.created, message.delivered, message.read, message.failed Tiek publicēts ziņojums vai mainās tā piegādes statuss
crm.* crm.lead.created, crm.contact.created, crm.contact.updated, crm.contact.merged, crm.deal.stage_changed, crm.deal.won Mainās potenciālais klients, kontakts, uzņēmums vai darījums
ticket.* ticket.created, ticket.status_changed, ticket.assigned, ticket.sla_breached Mainās pieteikums
visitor.* visitor.identified, visitor.cobrowse.requested Apmeklētājs tiek identificēts vai lūdz kopīgas pārlūkošanas sesiju
marketing.* marketing.form.submitted, marketing.booking.created, marketing.campaign.sent, marketing.unsubscribed Veidlapas, rezervācijas, kampaņas
kb.* kb.article.published, kb.article.unpublished Zināšanu bāzes izmaiņas
phone.* phone.call.started, phone.call.ended, phone.call.recorded, phone.call.transcribed, phone.voicemail.received Zvani un balss pasts
automation.* automation.rule.executed, automation.rule.failed Tiek izpildīts automatizācijas noteikums
privacy.* privacy.consent.granted, privacy.consent.withdrawn, privacy.dsr.received Piekrišana un datu subjektu pieprasījumi
billing.* billing.invoice.created, billing.trial_expiring, billing.subscription.changed Abonements un rēķini
auth.* auth.api_key.created, auth.api_key.revoked, auth.account.swapped Drošības ziņā nozīmīgi konta notikumi
ai.* ai.usage.recorded Katrs AI adaptera izsaukums ar marķieru skaitu

Precīzais saraksts aug līdz ar produktu; abonēšanas ekrānā redzams katrs veids, ko jūsu konts var saņemt, un to var filtrēt pēc veida.

Abonēšana

Section titled “Abonēšana”

Webhook abonementi pieder spraudnim. Sadaļā Iestatījumi → Spraudņi atveriet spraudni (vai izveidojiet pielāgotu) un pievienojiet galapunktu: HTTPS URL, vēlamos notikumu veidus un neobligātu IP atļauto sarakstu. Parakstīšanas noslēpums tiek parādīts vienreiz. Šī galapunkta piegādes, atkārtojumi un nepiegādātās vēstules parādās spraudņa Webhook žurnālā.

Spraudņu protokols lapā Spraudņi apraksta, kā spraudnis savā manifestā deklarē nepieciešamos notikumus.

Secība un piegāde

Section titled “Secība un piegāde”
  • Piegāde notiek vismaz vienreiz. Novērsiet dublikātus pēc id.
  • Viena resursa notikumi tiek nosūtīti secīgi, bet atkārtojumi var mainīt piegāžu secību. Izmantojiet occurred_at un resursa updated_at, nevis saņemšanas laiku.
  • Abonements, kas turpina neizdoties, uzkrāj nepiegādātās vēstules; vairāk nekā 100 vienam galapunktam RolChat pusē izraisa brīdinājumu un spraudņa žurnālā parāda brīdinājumu.