API reference

Events

Name: Deel Flows
Price: 29 USD

Track what your contacts do — orders, bookings, page visits. Events can start journeys and power event-based segments.

POST/v1/events

Record an event for a contact, identified by contactId or phone. Returns 202 — events are processed asynchronously.

Body

Field	Type	Description
`event`required	string	Event name, e.g. order_placed. Use stable snake_case names.
`contactId`	string	Contact id (from the Contacts API). Either this or phone.
`phone`	string	E.164 phone of an existing contact. Either this or contactId.
`properties`	object	Arbitrary event payload, available to journeys and segments.

curl

curl -X POST https://app.deelflows.com/api/v1/events \
  -H "Authorization: Bearer df_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+15551234567",
    "event": "order_placed",
    "properties": { "orderId": "1042", "total": 129.5 }
  }'

Response 202

{ "accepted": true }

The contact must already exist — create it first via POST /v1/contacts. Unknown contacts return 404.