The Encharge Ingest API lets you create/update people and submit events from your app's backend directly to Encharge. The API exposes a single endpoint.
See this documentation as a Postman Collection.
Get your write key for the Ingest API in Your Account.
email
or userId
is required to uniquely identify this person. Any other fields in properties will be added as custom fields to people.​
​
Send date fields formatted as ISO 8601 datetime values. For example, 2020-10-27T07:58:19+00:00
or 2020-10-27T07:58:19Z
.
Pass the IP of the user (as property ip
in the user
object) to automatically populate the user country and timezone. Alternatively, you might set the sourceIp
as shown above.
You can pass comma-separated tags
property in the user
object to easily add tags to the user. For example: {"user": { "userId": 123, "tags": "tag1, tag2"}}