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 [email protected] 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:   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

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

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

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:  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.
Email 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.
Email 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.

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

Untag User

Remove tags from a user in Encharge.

  FIELD              DESCRIPTION
  Tag* Type:   STRING
The tags to remove, separated by commas.
  Email 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.

Don't forget to Book a call if you need further help.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Related Articles