Events API
Track customer behavior to drive automations and segments.
View as Markdown ↗Project key. Acts in the project the key belongs to. An all-access key works too — name the project with an X-Project-Id header. How keys and scopes work.
Endpoint
/v1/eventsTrack behavior to power automations and segments. Identify the contact by email (auto-created if unknown) or contact_id.
Track an event
Body parameters
eventstringrequiredEvent name, e.g. Purchased. Stored with a normalized key.
emailstringoptionalIdentify the contact by email (auto-created if unknown).
contact_idstringoptionalIdentify the contact by id instead of email.
propertiesobjectoptionalArbitrary metadata (product_id, category, …).
valuenumberoptionalMonetary value for revenue tracking.
currencystringoptionalISO currency code for value, e.g. usd.
quantityintegeroptionalItem quantity for the event (e.g. units purchased).
occurred_atstringoptionalISO 8601 timestamp of when the event happened. Defaults to now.
Provide either email or contact_id.
curl -X POST https://emailbump.com/api/v1/events \
-H "Authorization: Bearer ebk_your_key" \
-H "Content-Type: application/json" \
-d '{
"email": "[email protected]",
"event": "Purchased",
"value": 49.0,
"currency": "usd",
"properties": { "product": "Widget" }
}'