Skip to main content
POST
/
v1
/
events
Aampe Ingest
curl --request POST \
  --url https://api.example.com/v1/events \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": "<string>",
  "event_name": "<string>",
  "timestamp": 123,
  "timezone": "UTC",
  "event_id": "4e4e7dab-91b3-4fa1-9dd8-531ba9036a2f",
  "metadata": {}
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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
required

Unix time of the event

timezone
string | null
default:UTC

Local timezone where the event took place

event_id
string | null
default:4e4e7dab-91b3-4fa1-9dd8-531ba9036a2f

Optional unique ID of the event

metadata
Metadata · object

Optional dictionary representing any extra metadata

Response

Successful Response