Ingest API
Last updated
Was this helpful?
Last updated
Was this helpful?
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 .
Don't use this API, if you are building an integration with Encharge to be used by our mutual customers. For example, if your product is a form builder and you'd like to send leads to Encharge, use the . The Ingest API is the wrong tool for the job and will result in poor experience for our mutual users.
Get your write key for the Ingest API in .
Use the below endpoint to create/update people and submit events from your app's backend directly to Encharge. See below for sample events
POST
https://ingest.encharge.io/v1/
Create/update person or record events for existing people.
X-Encharge-Token
string
Write key for your account.
Content-Type
string
Content-type must be application/json
name
string
Name of your event. If you are using this API to create/update people, you can use "identify" as the event name.
user
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
object
Properties for this event.
sourceIp
string
IP of the end user, if available.
Below you can find some samples on how to use the Ingest API. While these are using the curl script, you can import them into Postman to get sample snippets for your preferred language/lib.
A sample call to create the user upon registration. The event has properties describing the user's plan and trial.
A sample call about an action that the user performed in your app (created a page). In this case, the user is identified with their userId
and the event has no properties
.
A sample call to record a form submission by a user. The user email is supplied to identify the user and the properties
are the form fields.
Encharge defines the following special events:
Use this event to change the userId
and/or email
of a user in your Encharge account.
Please note that you can provide both an email and a User Id.
The event has the following extra properties:
type
Should be set to "alias"
previousEmail
If changing the email address, the previous email of the user. Optional.
user.email
If changing the email address, the new email of the user. Optional.
previousUserId
If changing the User Id, the previous User Id. Optional.
user.userId
If changing the User Id, the new User Id. Optional.
Sample call:
Create or Update a Custom Object (including Companies) in Encharge.
Additionally, if an Email or a User ID is provided, an Encharge user will be associated with the object. A new user will be created if the email or user ID does not exist in Encharge.
The event has the following extra properties:
type
Should be set to "group"
objectType
The name of the object to create/update (e.g. company
). Make sure to create the object schema beforehand, either in the Encharge app or via the API.
properties
Dictionary of object fields to associate with the object in Encharge. Any unexisting fields will be ignored.
If you want to update an existing object in Encharge, make sure to pass id
or externalId
in the properties.
user.userId
If you want to associate the object with a user in Encharge, pass the User Id here. Optional.
user.email
If you want to associate the object with a user in Encharge, pass the user email here. Optional.
Sample call:
Alternatively, you can use the library.