Events

Track an event

Ingest a product event for a contact (auto-created if unknown). Accepts the public key (pk_…), so it is safe to call from client-side code. Names with the email./contact./segment./workflow. prefixes are reserved for system events. Events feed segments, workflow triggers, and webhooks.

post/v1/events

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/events
  • Auth: HTTP bearer

Request body

namestring required

Your event name, e.g. user.signup (reserved prefixes excluded).

emailstring email required

The contact the event belongs to.

dataobject

Properties of the event — what happened. Point-in-time; never applied to the contact.

Response

Event recorded, with what it set off.

eventIdstring required
contactIdstring required

The contact the event was attributed to, created if it did not exist.

Changes

No recorded changes to this operation across all 1 revision of this API.