Оқиғалар каталогы

Деректер пішімі

Әр оқиға - бір JSON нысаны:

{
  "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 - X-RolChat-Event-Id тақырыбындағы мән, ол қайталаулар кезінде өзгермейді. type - snake_case түріндегі <domain>.<noun>.<verb> немесе <domain>.<verb>. data ресурсты тиісті GET эндпоинті қайтаратындай түрде береді, сондықтан қабылдағышты API анықтамасы бойынша жазуға болады және оған екінші схема ешқашан керек болмайды.

Оқиғалар топтары

Топ	Мысалдар	Қашан жіберіледі
conversation.*	conversation.created, conversation.assigned, conversation.resolved, conversation.reopened, conversation.merged	Сұхбаттың күйі немесе иесі өзгереді
message.*	message.created, message.delivered, message.read, message.failed	Хабарлама жарияланады немесе оның жеткізу күйі өзгереді
crm.*	crm.lead.created, crm.contact.created, crm.contact.updated, crm.contact.merged, crm.deal.stage_changed, crm.deal.won	Лид, контакт, компания немесе мәміле өзгереді
ticket.*	ticket.created, ticket.status_changed, ticket.assigned, ticket.sla_breached	Тикет өзгереді
visitor.*	visitor.identified, visitor.cobrowse.requested	Келуші сәйкестендіріледі немесе бірлесіп шолу сессиясын сұрайды
marketing.*	marketing.form.submitted, marketing.booking.created, marketing.campaign.sent, marketing.unsubscribed	Формалар, брондаулар, науқандар
kb.*	kb.article.published, kb.article.unpublished	Білім базасындағы өзгерістер
phone.*	phone.call.started, phone.call.ended, phone.call.recorded, phone.call.transcribed, phone.voicemail.received	Қоңыраулар және дауыстық пошта
automation.*	automation.rule.executed, automation.rule.failed	Автоматтандыру ережесі орындалады
privacy.*	privacy.consent.granted, privacy.consent.withdrawn, privacy.dsr.received	Келісім және деректер субъектілерінің сұраулары
billing.*	billing.invoice.created, billing.trial_expiring, billing.subscription.changed	Жазылым және шот-фактуралар
auth.*	auth.api_key.created, auth.api_key.revoked, auth.account.swapped	Аккаунттың қауіпсіздікке қатысты оқиғалары
ai.*	ai.usage.recorded	Токендер саны көрсетілген әр AI адаптерін шақыру

Нақты тізім өніммен бірге толығады; жазылым экраны аккаунтыңыз ала алатын әр түрді көрсетеді және түрі бойынша сүзуге мүмкіндік береді.

Жазылу

Вебхук жазылымдары плагинге тиесілі. Баптаулар → Плагиндер бөлімінде плагинді ашып (немесе жеке плагин жасап), эндпоинт қосыңыз: HTTPS URL, қажетті оқиға түрлері және міндетті емес рұқсат етілген IP тізімі. Қол қою құпиясы бір рет көрсетіледі. Сол эндпоинтке жеткізулер, қайталаулар және жеткізілмеген хабарламалар плагиннің Вебхук журналында көрінеді.

Плагиндер бетіндегі Plugin Protocol плагиннің өзіне қажет оқиғаларды манифестте қалай жариялайтынын сипаттайды.

Рет және жеткізу

• Жеткізу кемінде бір рет орындалады. Қайталанатындарды id бойынша алып тастаңыз.
• Бір ресурсқа қатысты оқиғалар ретімен жіберіледі, бірақ қайталаулар жеткізу ретін өзгертуі мүмкін. Келу уақытының орнына occurred_at пен ресурстың updated_at мәнін пайдаланыңыз.
• Үнемі сәтсіз аяқталатын жазылымда жеткізілмеген хабарламалар жиналады; бір эндпоинтке 100-ден асса, RolChat жағында дабыл көтеріліп, плагин журналында ескерту көрсетіледі.