Encharge (Actions) Destination
Encharge is a marketing automation platform built for B2B SaaS businesses.
With Encharge, you can nurture, convert, and onboard customers with advanced behavior emails, company profiles, billing integrations, and CRM sync.
Encharge maintains this destination. For any issues with the destination, contact the Encharge Support team.
This document is about a destination which is in beta
This means that the Encharge (Actions) Destination is in active development, and some functionality may change before it becomes generally available.
Getting started
- From the Segment web app, navigate to Connections.
- Click Add Destination.
- Search for the Encharge (Actions) destination.
- Select the Source you want to connect to your Destination.
- Click Next.
- Give your Destination a name.
- Click Create Destination.
- Configure the settings and enable your destination on the destination settings page.
- Enter the API Key. This can be found on your Account page.
- Click Save Changes.
- To start with pre-populated event subscriptions, enable the Enable Destination and click Save Changes. Otherwise, click on the Mappings tab to configure each action, and then enable the destination.
Destination Settings
Setting | Description |
---|---|
API Key | Required. Encharge.io API Key. This can be found on your Account page. |
Available Presets
Encharge (Actions) has the following presets:
Preset Name | Trigger | Default Action |
---|---|---|
Alias User | Event type = "alias" |
Alias User |
Identify User | Event type = "identify" |
Identify User |
Track Page View | Event type = "page" |
Track Page View |
Create or Update Object | Event type = "group" |
Create or Update Object |
Track Event | Event type = "track" |
Track Event |
Available Actions
Build your own Mappings. Combine supported triggers with the following Encharge-supported actions:
Mapping limits per destination
Individual destination instances have support a maximum of 50 mappings.
Untag User
Remove tags from a user in Encharge.
Untag User is a Cloud action.
Field | Description |
---|---|
Tag* | Type: STRING The tags to remove, separated by commas. |
Type: STRING The email address of the user. |
|
User ID | Type: STRING The User ID associated with the user in Encharge. |
Anonymous ID | Type: STRING An anonymous identifier for this user. |
Identify User
Identify a user in Encharge. This will create a new user if the user does not exist in Encharge.
Identify User is a Cloud action. The default Trigger is: type = "identify"
Field | Description |
---|---|
User Fields | Type: OBJECT Fields to associate with the user in Encharge. Any unexisting fields will be automatically created in Encharge. |
Type: STRING The email address of the user. |
|
Type* | Type: STRING The type of event. |
Anonymous ID | Type: STRING An anonymous identifier for this user. |
User ID | Type: STRING The User ID associated with the user in Encharge. |
Group ID | Type: STRING An ID associating the event with a group. |
Timestamp | Type: STRING The timestamp of the event |
MessageId | Type: STRING The Segment messageId |
IP Address | Type: STRING The IP address of the user. |
User Agent | Type: STRING The user agent of the user. Used to determine the device, browser and operating system. |
Campaign | Type: OBJECT UTM campaign information. |
Page | Type: OBJECT Information about the page where the event occurred. |
Location | Type: OBJECT Information about the location of the user. |
Alias User
Change the User ID of an user.
Alias User is a Cloud action. The default Trigger is: type = "alias"
Field | Description |
---|---|
User ID* | Type: STRING The new User ID to associate with the user in Encharge. |
Previous User ID* | Type: STRING The previous User ID associated with the user in Encharge. |
Timestamp | Type: STRING The timestamp of the event |
MessageId | Type: STRING The Segment messageId |
Create or Update Object
Create or Update a Custom Object (including Companies) in Encharge. 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.
Create or Update Object is a Cloud action. The default Trigger is: type = "group"
Field | Description |
---|---|
Object Type* | Type: STRING The type of Encharge object to create or update. |
External Object ID | Type: STRING An ID from your app/database that is used to uniquely identify the object in Encharge. |
Object ID | Type: STRING The Encharge ID of the object. Usually, you want to omit this and use External ID. |
Object Fields | Type: OBJECT Data for the object fields in Encharge. Any unexisting fields will be ignored. |
User ID | Type: STRING The User ID of the user to associate with the object. If no email or user ID is provided, no user will be created and associated. |
Type: STRING The email of the user to associate with the object. If no email or user ID is provided, no user will be created and associated. |
Tag User
Add a tag to a user in Encharge.
Tag User is a Cloud action.
Field | Description |
---|---|
Tag* | Type: STRING The tags to add, separated by commas. |
Type: STRING The email address of the user. |
|
User ID | Type: STRING The User ID associated with the user in Encharge. |
Anonymous ID | Type: STRING An anonymous identifier for this user. |
Track Event
Track an event in Encharge for a known or anonymous person.
Track Event is a Cloud action. The default Trigger is: type = "track"
Field | Description |
---|---|
Event Name* | Type: STRING The name of the event. |
Event Properties | Type: OBJECT The properties of the event. |
User Fields | Type: OBJECT Any default or custom field of the user. On the left-hand side, input the API name of the field as seen in your Encharge account. On the right-hand side, map the Segment field that contains the value. Any properties that don’t exist will be created automatically. See more information in Encharge’s documentation. |
Type* | Type: STRING The type of event. |
Type: STRING The email address of the user. |
|
Anonymous ID | Type: STRING An anonymous identifier for this user. |
User ID | Type: STRING The User ID associated with the user in Encharge. |
Group ID | Type: STRING An ID associating the event with a group. |
Timestamp | Type: STRING The timestamp of the event |
MessageId | Type: STRING The Segment messageId |
IP Address | Type: STRING The IP address of the user. |
User Agent | Type: STRING The user agent of the user. Used to determine the device, browser and operating system. |
Campaign | Type: OBJECT UTM campaign information. |
Page | Type: OBJECT Information about the page where the event occurred. |
Location | Type: OBJECT Information about the location of the user. |
Track Page View
Track a website page visit.
Track Page View is a Cloud action. The default Trigger is: type = "page"
Field | Description |
---|---|
Page View Properties | Type: OBJECT Custom properties to send with the pageview. Please note that URL, title, refererrer, path and search are automatically collected and don’t have to be mapped here. |
User Fields | Type: OBJECT Any default or custom field of the user. On the left-hand side, input the API name of the field as seen in your Encharge account. On the right-hand side, map the Segment field that contains the value. Any properties that don’t exist will be created automatically. See more information in Encharge’s documentation. |
Type* | Type: STRING The type of event. |
Type: STRING The email address of the user. |
|
Anonymous ID | Type: STRING An anonymous identifier for this user. |
User ID | Type: STRING The User ID associated with the user in Encharge. |
Group ID | Type: STRING An ID associating the event with a group. |
Timestamp | Type: STRING The timestamp of the event |
MessageId | Type: STRING The Segment messageId |
IP Address | Type: STRING The IP address of the user. |
User Agent | Type: STRING The user agent of the user. Used to determine the device, browser and operating system. |
Campaign | Type: OBJECT UTM campaign information. |
Page | Type: OBJECT Information about the page where the event occurred. |
Location | Type: OBJECT Information about the location of the user. |
This page was last modified: 12 Feb 2024
Need support?
Questions? Problems? Need more info? Contact Segment Support for assistance!