Segment Actions
Segment Actions
By default, Encharge accepts the following Segment destination actions (not to be confused with flow actions in Encharge):
★ Premium feature: Segment integration is only available on the Premium plans. Please don't hesitate to send us a message at support@encharge.io for further guidance. Additionally, feel free to book a call, and we can directly discuss how to fit Segment.com with your use case.
Alias User
Change the User ID of a user. Alias User is a Cloud action. The default Trigger is: type = "alias"
FIELD | DESCRIPTION |
|---|---|
User ID* | Type: STRINGThe new User ID to associate with the user in Encharge. |
Previous User ID* | Type: STRINGThe previous User ID associated with the user in Encharge. |
Timestamp | Type: STRINGThe timestamp of the event |
MessageId | Type: STRINGThe Segment messageId |
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: OBJECTFields to associate with the user in Encharge. Any unexisting fields will be automatically created in Encharge. |
Type: STRINGThe email address of the user. | |
Type* | Type: STRINGThe type of event. |
Anonymous ID | Type: STRINGAn anonymous identifier for this user. |
User ID | Type: STRINGThe User ID associated with the user in Encharge. |
Group ID | Type: STRINGAn ID associating the event with a group. |
Timestamp | Type: STRINGThe timestamp of the event |
MessageId | Type: STRINGThe Segment messageId |
IP Address | Type: STRINGThe IP address of the user. |
User Agent | Type: STRINGThe user agent of the user. Used to determine the device, browser and operating system. |
Campaign | Type: OBJECTUTM campaign information. |
Page | Type: OBJECTInformation about the page where the event occurred. |
Location | Type: OBJECTInformation about the location of the user. |
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: STRINGThe type of Encharge object to create or update. |
External Object ID | Type: STRINGAn ID from your app/database that is used to uniquely identify the object in Encharge. |
Object ID | Type: STRINGThe Encharge ID of the object. Usually, you want to omit this and use External ID. |
Object Fields | Type: OBJECTData for the object fields in Encharge. Any unexisting fields will be ignored. |
User ID | Type: STRINGThe 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: STRINGThe email of the user to associate with the object. If no email or user ID is provided, no user will be created and associated. |
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"
Track Event sends events to Encharge, which are used with the Segment Event trigger step in flows to automate things based on events.
FIELD | DESCRIPTION |
|---|---|
Event Name* | Type: STRINGThe name of the event. |
Event Properties | Type: OBJECTThe properties of the event. |
User Fields | Type: OBJECTAny 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: STRINGThe type of event. |
Type: STRINGThe email address of the user. | |
Anonymous ID | Type: STRINGAn anonymous identifier for this user. |
User ID | Type: STRINGThe User ID associated with the user in Encharge. |
Group ID | Type: STRINGAn ID associating the event with a group. |
Timestamp | Type: STRINGThe timestamp of the event |
MessageId | Type: STRINGThe Segment messageId |
IP Address | Type: STRINGThe IP address of the user. |
User Agent | Type: STRINGThe user agent of the user. Used to determine the device, browser and operating system. |
Campaign | Type: OBJECTUTM campaign information. |
Page | Type: OBJECTInformation about the page where the event occurred. |
Location | Type: OBJECTInformation 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: OBJECTCustom 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: OBJECTAny 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: STRINGThe type of event. |
Type: STRINGThe email address of the user. | |
Anonymous ID | Type: STRINGAn anonymous identifier for this user. |
User ID | Type: STRINGThe User ID associated with the user in Encharge. |
Group ID | Type: STRINGAn ID associating the event with a group. |
Timestamp | Type: STRINGThe timestamp of the event |
MessageId | Type: STRINGThe Segment messageId |
IP Address | Type: STRINGThe IP address of the user. |
User Agent | Type: STRINGThe user agent of the user. Used to determine the device, browser and operating system. |
Campaign | Type: OBJECTUTM campaign information. |
Page | Type: OBJECTInformation about the page where the event occurred. |
Location | Type: OBJECTInformation about the location of the user. |
Tag User
Add a tag to a user in Encharge.Tag User is a Cloud action.
FIELD | DESCRIPTION |
|---|---|
Tag* | Type: STRINGThe tags to add, separated by commas. |
Type: STRINGThe email address of the user. | |
User ID | Type: STRINGThe User ID associated with the user in Encharge. |
Anonymous ID | Type: STRINGAn anonymous identifier for this user. |
Untag User
Remove tags from a user in Encharge.
FIELD | DESCRIPTION |
|---|---|
Tag* | Type: STRINGThe tags to remove, separated by commas. |
Type: STRINGThe email address of the user. | |
User ID | Type: STRINGThe User ID associated with the user in Encharge. |
Anonymous ID | Type: STRINGAn anonymous identifier for this user. |
Don't forget to Book a call if you need further help.
Updated on: 21/04/2025
Thank you!