ارسال یک رویداد
ثبت می‌کند که یک مخاطب در محصول شما کاری کرده است. رویداد هر خودکارسازی فعالی را که آغازگرش آن را نام می‌برد شروع می‌کند و هر کسی را که منتظرش بود جلو می‌برد.
هر کدام از 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 است.