IntegrationsCustom

API payload reference

Reference for the exact request bodies the engine accepts on the core v1 ingest routes.

Source of truthserver/engine/cmd/sankofa/main.go

Track payload

Field	Type	Required	Description
`event_name`	string	Yes	Stable event name such as signup_completed or payment_failed.
`distinct_id`	string	Yes	The active user identifier or anonymous identifier for the event.
`properties`	map<string, string>	No	Event-specific properties. Include $session_id here when you want session correlation.
`default_properties`	map<string, string>	No	Context fields such as $os, $device_model, $country, and other SDK-provided defaults.
`lib_version`	string	No	Client library version label such as flutter-0.0.1 or your own custom sender label.

Field	Type	Required	Description
`distinct_id`	string	Yes	The user identity whose profile should be updated.
`properties`	map<string, string>	Yes	Flat profile properties to merge into the person record.

Field	Type	Required	Description
`alias_id`	string	Yes	The previous anonymous or legacy identifier.
`distinct_id`	string	Yes	The new canonical identifier to stitch future analysis against.

The engine promotes some high-value data from payloads into indexed fields:

HTTP ingestion

Send events, people updates, and aliases directly to the Sankofa engine over the v1 ingest API.

Alias and identity

Stitch anonymous activity into known users and keep your event stream analyzable across signup and login boundaries.