Ingest API

Description

The 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.

Authentication

Get your write key for the Ingest API in Your Account.

Endpoints

post
/

https://ingest.encharge.io/v1/
Create/update person or record events for existing people.
Request
Response
Request
Headers
X-Encharge-Token
required
string
Write key for your account.
Content-Type
required
string
Content type must be application/json
Body Parameters
name
required
string
Name of your event. If you are using this API to create/update people, you can use "identify" as the event name.
user
required
object
Properties for the current user. email or userId is required to uniquely identify this person. Any other fields in properties will be added as custom fields to people.
properties
optional
object
Properties for this event.
sourceIp
optional
string
IP of the end user, if available.
Response
200: OK

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.