إرسال حدث
يسجّل أن جهة اتصال فعلت شيئًا في منتجك. فيبدأ الحدث كل أتمتة منشورة يسمّيه مشغِّلها، ويدفع إلى الأمام كل من كان ينتظره.
ينفّذ أيًّا من الاستدعاءات الـ2 على مساحة عملك.
POST /events
يسجّل أن جهة اتصال فعلت شيئًا في منتجك. فيبدأ الحدث كل أتمتة منشورة يسمّيه مشغِّلها، ويدفع إلى الأمام كل من كان ينتظره.
مثال
يتطلب contacts:write. حدّد جهة الاتصال بـ email أو بـ contactId.
curl -X POST "$OE/events" -H "$AUTH" -H 'content-type: application/json' -H 'Idempotency-Key: order-A-1042' -d '{ "name": "order.placed", "email": "[email protected]", "properties": { "orderId": "A-1042", "total": 59 }, "createContact": true}'{ "object": "contact_event", "id": "cev_6a1d9f3c8b2e40a75d9c1e38", "contactId": "5b0e7c1a-2f4d-4c8b-9a36-1e7d0c5f8b24", "email": "[email protected]", "name": "order.placed", "properties": { "orderId": "A-1042", "total": 59 }, "occurredAt": "2026-10-11T08:02:03.000Z", "mode": "live", "createdAt": "2026-10-11T08:02:03.412Z", "replayed": false, "enrolled": ["aut_7c2e9a1f4b8d30c65e1a9f27"], "resumed": 0}يتكوّن name من 100 على الأكثر من الحروف والأرقام والنقاط والنقطتين الرأسيتين والشرطات والشرطات السفلية، ويبدأ بحرف أو رقم. والأسماء حساسة لحالة الأحرف.
يتسع properties لـ 50 مفتاحًا و4 كيلوبايت من JSON على الأكثر. ويستطيع قراءتها مرشِّح المشغِّل وقيمة في رسالة والتفرّع.
القيمة الافتراضية لـ occurredAt هي الآن. ويمكن أن يقع في الماضي حتى 90 يومًا، وفي المستقبل بما لا يزيد على 5 دقائق.
العنوان غير المعروف يجيب بـ 404 contact_not_found ما لم تكن قيمة createContact هي true، فتُضاف جهة الاتصال ويكون contactName اسمها.
يسرد enrolled الأتمتات التي دخلتها جهة الاتصال، ويعدّ resumed فترات الانتظار التي أنهاها الحدث.
إرسال Idempotency-Key نفسه مرة أخرى يجيب بـ 200 مع الحدث الأول وreplayed: true. والمفتاح نفسه مع متن مختلف يُرفض بـ 422 idempotency_key_reuse.
الحدث المرسَل بمفتاح اختبار يُخزَّن مع mode: "test" ولا يبدأ شيئًا.
دفعة
يقبل POST /events/batch حتى 100 حدث في events، كل منها بشكل المتن أعلاه. ويجيب بـ 200 حتى لو رُفض بعضها، ويذكر أيّها.
curl -X POST "$OE/events/batch" -H "$AUTH" -H 'content-type: application/json' -d '{ "events": [ { "name": "order.placed", "email": "[email protected]" }, { "name": "order.placed", "email": "[email protected]" } ]}'{ "object": "contact_event_batch", "accepted": [{ "index": 0, "object": "contact_event", "id": "cev_6a1d9f3c8b2e40a75d9c1e38", "…": "…" }], "failed": [{ "index": 1, "code": "contact_not_found", "message": "No contact with that address. Pass createContact: true to add one." }]}index هو موضع الحدث في المصفوفة التي أرسلتها.
يمكن للمفتاح أو التطبيق إرسال 600 حدث في الدقيقة. وبعد ذلك تكون الاستجابة 429 event_rate_limited.