Events

POST /api/v1/events

The call upserts the contact by email address. It then starts one run for every enabled automation whose trigger is event with this name. SEND keys may call it.

Field	Type	Notes
name	string	Required. Event name, 1–128 chars, e.g. "order.paid". Matched exactly against automation triggers.
email	string	Required. The contact (created if new; lower-cased).
data	object	Optional scalar properties (same rules as contact properties). Merged into the properties of the contact and available to the send steps of the automation as template data.
id	string	Optional client id (1–128 chars). Defaults to a random UUID. The same id for the same automation and contact does not start a second run.

The API rejects unknown fields.

curl -X POST https://api.f5send.com/api/v1/events \
  -H "Authorization: Bearer $F5SEND_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "order.paid", "email": "jane@example.org", "id": "order_8812", "data": { "order_total": 42.5 } }'

{ "id": "order_8812", "runs": 1 }

runs is the number of automation runs that the call started. Two daily per-organization quotas apply; see Rate limits & idempotency. The API returns 429 contact_quota_exceeded when a new contact would exceed the new-contact quota. It returns 429 run_quota_exceeded when the run quota is spent. Automations explains how triggers and steps work.