इवेंट भेजें
दर्ज करता है कि किसी संपर्क ने आपके प्रोडक्ट में कुछ किया। इवेंट हर उस लाइव ऑटोमेशन को शुरू करता है जिसके ट्रिगर में उसका नाम है, और जो कोई उसका इंतज़ार कर रहा था उसे आगे बढ़ाता है।
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 KB JSON होता है। ट्रिगर का फ़िल्टर, ईमेल का मान और ब्रांच इन्हें पढ़ सकते हैं।
occurredAt का डिफ़ॉल्ट अभी का समय है। यह अधिकतम 90 दिन पहले का और अधिकतम 5 मिनट आगे का हो सकता है।
अनजान पता 404 contact_not_found लौटाता है, जब तक createContact true न हो, जो संपर्क को जोड़ देता है और contactName को उसका नाम बनाता है।
enrolled उन ऑटोमेशन की सूची देता है जिनमें संपर्क अंदर आया, और resumed उन इंतज़ारों को गिनता है जिन्हें इवेंट ने ख़त्म किया।
वही Idempotency-Key दोबारा भेजने पर पहले इवेंट और replayed: true के साथ 200 मिलता है। अलग बॉडी के साथ वही कुंजी 422 idempotency_key_reuse के साथ मना की जाती है।
टेस्ट कुंजी से भेजा गया इवेंट mode: "test" के साथ सहेजा जाता है और कुछ शुरू नहीं करता।
बैच
POST /events/batch events में अधिकतम 100 इवेंट लेता है, हर एक ऊपर की बॉडी जैसा। कुछ के मना होने पर भी यह 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 होता है।