Events API

Send contact events to drive segmentation and automation triggers.

Send contact events to drive segmentation and automation triggers.

Endpoint

MethodPath
POST/api/v1/events

Request body

{
  "email": "john@example.com",
  "eventName": "purchase_completed",
  "eventProperties": {
    "orderId": "ORD-123",
    "amount": 99.99
  },
  "createContactIfNotExists": true
}

Fields:

  • email (required)
  • eventName (required)
  • eventProperties (optional object)
  • createContactIfNotExists (optional boolean, default false)

eventName constraints:

  • must start with a letter
  • allowed chars: letters, numbers, _, -
  • max length: 100

Success response

{
  "data": {
    "eventId": "evt_m6e...",
    "contactId": "j57...",
    "eventName": "purchase_completed",
    "triggeredAutomations": 1,
    "contactCreated": true
  }
}

Common errors

  • 404 contact_not_found when contact does not exist and createContactIfNotExists is not enabled
  • 400 invalid_event_name for invalid event naming
  • 400 invalid_json for malformed payloads