ข้ามไปยังเนื้อหา

แค็ตตาล็อกเหตุการณ์

ทุกเหตุการณ์เป็นออบเจ็กต์ 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 อยู่ในรูป <domain>.<noun>.<verb> หรือ <domain>.<verb> แบบ snake_case 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 พร้อมจำนวนโทเค็น

รายการที่แน่นอนจะเพิ่มขึ้นตามผลิตภัณฑ์ หน้าจอการสมัครรับแสดงทุกประเภทที่บัญชีของคุณรับได้และให้กรองตามประเภทได้

การสมัครรับเว็บฮุกเป็นของปลั๊กอิน ใน การตั้งค่า → ปลั๊กอิน เปิดปลั๊กอิน (หรือสร้างปลั๊กอินแบบกำหนดเอง) แล้วเพิ่มเอนด์พอยต์: URL แบบ HTTPS ประเภทเหตุการณ์ที่ต้องการ และรายการ IP ที่อนุญาตซึ่งไม่บังคับ ซีเคร็ตสำหรับลงลายมือชื่อแสดงครั้งเดียว การส่ง การลองใหม่ และ dead letter ของเอนด์พอยต์นั้นแสดงในบันทึกเว็บฮุกของปลั๊กอิน

Plugin Protocol ในหน้าปลั๊กอินอธิบายวิธีที่ปลั๊กอินประกาศเหตุการณ์ที่ต้องใช้ในแมนิเฟสต์

  • การส่งเป็นแบบอย่างน้อยหนึ่งครั้ง ลบรายการซ้ำตาม id
  • เหตุการณ์ของทรัพยากรเดียวกันถูกส่งตามลำดับ แต่การลองใหม่อาจทำให้ลำดับการส่งสลับกัน ให้ใช้ occurred_at และ updated_at ของทรัพยากรแทนเวลาที่ได้รับ
  • การสมัครรับที่ล้มเหลวต่อเนื่องจะสะสม dead letter หากเกิน 100 รายการสำหรับเอนด์พอยต์เดียว จะมีการแจ้งเตือนฝั่ง RolChat และแสดงคำเตือนในบันทึกของปลั๊กอิน