Katalogo ng event

Hugis ng payload

Iisang JSON object ang bawat event:

{
  "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 … }
}

Ang id ang value sa header na X-RolChat-Event-Id at hindi ito nagbabago sa mga retry. Ang type ay <domain>.<noun>.<verb> o <domain>.<verb> sa snake_case. Dala ng data ang resource gaya ng ibabalik ito ng katumbas na endpoint na GET, kaya maisusulat ang receiver batay sa reference ng API at hindi na kailangan ng pangalawang schema.

Mga pamilya ng event

Pamilya	Mga halimbawa	Inilalabas kapag
conversation.*	conversation.created, conversation.assigned, conversation.resolved, conversation.reopened, conversation.merged	Nagbago ang state o may-ari ng usapan
message.*	message.created, message.delivered, message.read, message.failed	Na-post ang mensahe o nagbago ang status ng delivery nito
crm.*	crm.lead.created, crm.contact.created, crm.contact.updated, crm.contact.merged, crm.deal.stage_changed, crm.deal.won	Nagbago ang lead, contact, kumpanya o deal
ticket.*	ticket.created, ticket.status_changed, ticket.assigned, ticket.sla_breached	Nagbago ang ticket
visitor.*	visitor.identified, visitor.cobrowse.requested	Nakilala ang bisita o humingi siya ng cobrowse session
marketing.*	marketing.form.submitted, marketing.booking.created, marketing.campaign.sent, marketing.unsubscribed	Mga form, booking, campaign
kb.*	kb.article.published, kb.article.unpublished	Mga pagbabago sa base ng kaalaman
phone.*	phone.call.started, phone.call.ended, phone.call.recorded, phone.call.transcribed, phone.voicemail.received	Mga tawag at voicemail
automation.*	automation.rule.executed, automation.rule.failed	Tumakbo ang rule ng automation
privacy.*	privacy.consent.granted, privacy.consent.withdrawn, privacy.dsr.received	Pahintulot at mga data-subject request
billing.*	billing.invoice.created, billing.trial_expiring, billing.subscription.changed	Subscription at mga invoice
auth.*	auth.api_key.created, auth.api_key.revoked, auth.account.swapped	Mga event ng account na may kinalaman sa seguridad
ai.*	ai.usage.recorded	Bawat tawag sa AI adapter, kasama ang bilang ng token

Lumalaki ang eksaktong listahan kasabay ng produkto; ipinapakita ng subscription screen ang bawat uri na puwedeng matanggap ng account mo at hinahayaan kang mag-filter kada uri.

Pag-subscribe

Kabilang sa isang plugin ang mga webhook subscription. Sa Mga Setting → Mga Plugin, buksan ang plugin (o gumawa ng custom) at magdagdag ng endpoint: HTTPS URL, ang mga uri ng event na gusto mo, at opsyonal na IP allowlist. Isang beses lang ipinapakita ang signing secret. Lumalabas sa Webhook log ng plugin ang mga delivery, retry at dead letter para sa endpoint na iyon.

Inilalarawan ng Plugin Protocol sa pahinang Mga plugin kung paano idinedeklara ng plugin sa manifest nito ang mga event na kailangan nito.

Pagkakasunod-sunod at delivery

• Kahit isang beses ang delivery. Mag-deduplicate ayon sa id.
• Ipinapadala nang sunud-sunod ang mga event para sa iisang resource, pero puwedeng magpabago ng pagkakasunod-sunod ng mga delivery ang mga retry. Gamitin ang occurred_at at ang updated_at ng resource sa halip na oras ng pagdating.
• Nag-iipon ng mga dead letter ang subscription na patuloy na bumibigo; kapag higit sa 100 para sa iisang endpoint, nagtataas ito ng alerto sa panig ng RolChat at nagpapakita ng babala sa log ng plugin.