Belgelere geç
API

Olay gönderme

Bir kişinin ürününüzde bir şey yaptığını kaydeder. Olay, tetikleyicisi onun adını veren yayındaki her otomasyonu başlatır ve onu bekleyen herkesi ilerletir.

POST/events

2 çağrıdan herhangi birini çalışma alanınızda çalıştırır.

POST /events

Bir kişinin ürününüzde bir şey yaptığını kaydeder. Olay, tetikleyicisi onun adını veren yayındaki her otomasyonu başlatır ve onu bekleyen herkesi ilerletir.

Örnek

contacts:write gerektirir. Kişiyi email ya da contactId ile belirtin.

curl
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}'
Yanıt
{  "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 en fazla 100 harf, rakam, nokta, iki nokta üst üste, tire ve alt çizgiden oluşur ve bir harf ya da rakamla başlar. Adlar büyük küçük harfe duyarlıdır.

properties en fazla 50 anahtar ve 4 KB JSON tutar. Bir tetikleyici filtresi, bir e-posta değeri ve bir dal bunları okuyabilir.

occurredAt varsayılan olarak şimdidir. En fazla 90 gün geçmişte ve en fazla 5 dakika gelecekte olabilir.

Bilinmeyen bir adres, createContact true olmadıkça 404 contact_not_found döner. O durumda kişi, adı contactName olacak şekilde eklenir.

enrolled, kişinin girdiği otomasyonları listeler, resumed ise olayın sona erdirdiği beklemeleri sayar.

Aynı Idempotency-Key değerini yeniden göndermek, ilk olay ve replayed: true ile 200 döner. Aynı anahtar farklı bir gövdeyle 422 idempotency_key_reuse ile reddedilir.

Test anahtarıyla gönderilen bir olay mode: "test" ile saklanır ve hiçbir şeyi başlatmaz.

Toplu

POST /events/batch, events içinde her biri yukarıdaki gövde biçiminde en fazla 100 olay alır. Bazıları reddedilse bile 200 döner ve hangileri olduğunu söyler.

curl
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]" }  ]}'
Yanıt
{  "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, olayın gönderdiğiniz dizideki konumudur.

Bir anahtar ya da uygulama dakikada 600 olay gönderebilir. Bundan sonra yanıt 429 event_rate_limited olur.

Referans