דלגו לתוכן

קטלוג האירועים

כל אירוע הוא אובייקט 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, עם ספירת אסימונים

הרשימה המדויקת גדלה יחד עם המוצר; מסך המינוי מציג כל סוג שהחשבון שלכם יכול לקבל ומאפשר לסנן לפי סוג.

מינויי webhook שייכים לתוסף. בהגדרות ← תוספים, פתחו את התוסף (או צרו תוסף מותאם) והוסיפו נקודת קצה: כתובת HTTPS, סוגי האירועים שאתם רוצים ורשימת היתרי IP אופציונלית. סוד החתימה מוצג פעם אחת. משלוחים, ניסיונות חוזרים והודעות מתות של נקודת הקצה הזו מופיעים ביומן Webhook של התוסף.

ה-Plugin Protocol בעמוד תוספים מתאר איך תוסף מצהיר במניפסט שלו על האירועים שהוא צריך.

  • המסירה היא לפחות פעם אחת. הסירו כפילויות לפי id.
  • אירועים של משאב אחד נשלחים לפי הסדר, אבל ניסיונות חוזרים יכולים לשנות את סדר המשלוחים. השתמשו ב-occurred_at וב-updated_at של המשאב במקום בזמן ההגעה.
  • מינוי שממשיך להיכשל צובר הודעות מתות; יותר מ-100 לנקודת קצה אחת מעלים התראה אצל RolChat ומציגים אזהרה ביומן התוסף.