イベントを送信する
連絡先があなたのプロダクトで何かをしたことを記録します。このイベントは、トリガーでそれを指定しているすべての公開中のオートメーションを開始し、それを待っていた人を先へ進めます。
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 キー、JSON で 4 KB です。トリガーのフィルター、メールの値、分岐から読み取れます。
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 は、送信した配列の中でのイベントの位置です。
キーまたはアプリが送信できるイベントは 1 分あたり 600 件です。それを超えると 429 event_rate_limited が返ります。