Track Event

POSThttps://api.inboxjot.com/v1/events

Records an event for a contact, such as a signup or a purchase. Inboxjot creates the contact when the address is new, then starts the automations that wait for this event. Needs a Full key. A key limited to one domain answers 403. Send an optional Idempotency-Key header to retry safely. See Idempotency.

POST/v1/events

curl -X POST https://api.inboxjot.com/v1/events \
  -H "Authorization: Bearer $INBOXJOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "order.completed",
    "email": "riti@example.com",
    "data": {
      "order_id": "4821",
      "total": 49
    }
  }'

{
  "contact_id": "con_06d2mfk8r9wq3zh5ka2pe"
}

Accepted. Inboxjot records the event in the background.

Body Parameters

namestringrequired

Event name, 1 to 100 characters. Start with a letter or number, then use letters, numbers, ., _, : or -.

emailstringrequired

The contact address. A new address creates a subscribed contact. Disposable addresses are refused.

dataobject

Event data, such as { "plan": "pro" }, up to 16 KB as JSON. Automations started by the event can use it in their emails.

Response

contact_idstring

The contact the event belongs to.

Responses

curl -X POST https://api.inboxjot.com/v1/events \ -H "Authorization: Bearer $INBOXJOT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "order.completed", "email": "riti@example.com", "data": { "order_id": "4821", "total": 49 } }'