Skip to main content
POST
Aampe Events Ingestion

Authorizations

Authorization
string
header
required

Your Ingestion API key. Obtain from Integrations > API keys in the Aampe Dashboard. See Authentication for details.

Body

application/json
contact_id
string
required

User ID that is triggering the event

Minimum string length: 1
event_name
string
required

The name of the event that took place

Minimum string length: 1
timestamp
number
required

Unix epoch seconds (number); decimals and millisecond values supported.

timezone
string | null
default:UTC

Local timezone where the event took place

event_id
string | null

Optional unique ID of the event

metadata
Metadata · object | null

Optional dictionary representing any extra metadata

Response

Successful Response