# Encharge (Actions) Destination ## Destination Info * Accepts [Page](/docs/segment/connections/spec/page), [Alias](/docs/segment/connections/spec/alias), [Group](/docs/segment/connections/spec/group), [Identify](/docs/segment/connections/spec/identify), [Track](/docs/segment/connections/spec/track) calls. * Refer to it as **Encharge Cloud (Actions)**, **Encharge (Actions)** in the [Integrations object.](/docs/segment/guides/filtering-data/#filtering-with-the-integrations-object) * This integration is **partner owned.** Please reach out to the partner's support for any issues. [Encharge](https://encharge.io/) 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](mailto:support@encharge.io). > \[!IMPORTANT] > > This means the feature is actively being developed, and some functionality may change before it becomes generally available. ## Getting started 1. From the Segment web app, navigate to **Connections**. 2. Click **Add Destination**. 3. Search for the **Encharge (Actions)** destination. 4. Select the Source you want to connect to your Destination. 5. Click **Next**. 6. Give your Destination a name. 7. Click **Create Destination**. 8. Configure the settings and enable your destination on the destination settings page. 9. Enter the **API Key**. This can be found on your [Account page](https://app.encharge.io/settings/api-keys). 10. Click **Save Changes**. 11. 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 | Field | Description | Required | Type | | ------- | ----------------------------------------------------------------------------------------------------------- | -------- | -------- | | API Key | Encharge.io API Key. This can be found on your \[Account page]\(https://app.encharge.io/settings/api-keys). | Yes | password | ## Available Presets Encharge (Actions) has the following presets | Preset Name | Trigger | Default Action | | ----------------------- | ----------------------- | ----------------------- | | Create or Update Object | Event type = "group" | Create or Update Object | | Alias User | Event type = "alias" | Alias User | | Identify User | Event type = "identify" | Identify User | | Track Event | Event type = "track" | Track Event | | Track Page View | Event type = "page" | Track Page View | ## Available Actions Build your own Mappings. Combine supported [triggers](/docs/segment/connections/destinations/actions/#components-of-a-destination-action) with the following Encharge-supported actions: > \[!NOTE] > > Individual destination instances have support a maximum of 50 mappings. * [Untag User](#untag-user) * [Identify User](#identify-user-1) * [Alias User](#alias-user) * [Create or Update Object](#create-or-update-object) * [Tag User](#tag-user) * [Track Event](#track-event-3) * [Track Page View](#track-page-view-1) ### Untag User Remove tags from a user in Encharge. Untag User is a **Cloud** action. | Field | Description | Required | Type | | ------------ | ------------------------------------------------- | -------- | ------ | | Tag | The tags to remove, separated by commas. | Yes | STRING | | Email | The email address of the user. | No | STRING | | User ID | The User ID associated with the user in Encharge. | No | STRING | | Anonymous ID | An anonymous identifier for this user. | No | STRING | ### 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 | Required | Type | | ------------ | --------------------------------------------------------------------------------------------------------------- | -------- | ------ | | User Fields | Fields to associate with the user in Encharge. Any unexisting fields will be automatically created in Encharge. | No | OBJECT | | Email | The email address of the user. | No | STRING | | Type | The type of event. | Yes | STRING | | Anonymous ID | An anonymous identifier for this user. | No | STRING | | User ID | The User ID associated with the user in Encharge. | No | STRING | | Group ID | An ID associating the event with a group. | No | STRING | | Timestamp | The timestamp of the event | No | STRING | | MessageId | The Segment messageId | No | STRING | | IP Address | The IP address of the user. | No | STRING | | User Agent | The user agent of the user. Used to determine the device, browser and operating system. | No | STRING | | Campaign | UTM campaign information. | No | OBJECT | | Page | Information about the page where the event occurred. | No | OBJECT | | Location | Information about the location of the user. | No | OBJECT | ### Alias User Change the User ID of an user. Alias User is a **Cloud** action. The default Trigger is `type = "alias"` | Field | Description | Required | Type | | ---------------- | ---------------------------------------------------------- | -------- | ------ | | User ID | The new User ID to associate with the user in Encharge. | Yes | STRING | | Previous User ID | The previous User ID associated with the user in Encharge. | Yes | STRING | | Timestamp | The timestamp of the event | No | STRING | | MessageId | The Segment messageId | No | STRING | ### 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 | Required | Type | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------- | -------- | ------ | | Object Type | The type of Encharge object to create or update. | Yes | STRING | | External Object ID | An ID from your app/database that is used to uniquely identify the object in Encharge. | No | STRING | | Object ID | The Encharge ID of the object. Usually, you want to omit this and use External ID. | No | STRING | | Object Fields | Data for the object fields in Encharge. Any unexisting fields will be ignored. | No | OBJECT | | User ID | 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. | No | STRING | | Email | 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. | No | STRING | ### Tag User Add a tag to a user in Encharge. Tag User is a **Cloud** action. | Field | Description | Required | Type | | ------------ | ------------------------------------------------- | -------- | ------ | | Tag | The tags to add, separated by commas. | Yes | STRING | | Email | The email address of the user. | No | STRING | | User ID | The User ID associated with the user in Encharge. | No | STRING | | Anonymous ID | An anonymous identifier for this user. | No | STRING | ### 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 | Required | Type | | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------ | | Event Name | The name of the event. | Yes | STRING | | Event Properties | The properties of the event. | No | OBJECT | | User Fields | 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]\(https://help.encharge.io/article/206-create-and-manage-custom-fields). | No | OBJECT | | Type | The type of event. | Yes | STRING | | Email | The email address of the user. | No | STRING | | Anonymous ID | An anonymous identifier for this user. | No | STRING | | User ID | The User ID associated with the user in Encharge. | No | STRING | | Group ID | An ID associating the event with a group. | No | STRING | | Timestamp | The timestamp of the event | No | STRING | | MessageId | The Segment messageId | No | STRING | | IP Address | The IP address of the user. | No | STRING | | User Agent | The user agent of the user. Used to determine the device, browser and operating system. | No | STRING | | Campaign | UTM campaign information. | No | OBJECT | | Page | Information about the page where the event occurred. | No | OBJECT | | Location | Information about the location of the user. | No | OBJECT | ### Track Page View Track a website page visit. Track Page View is a **Cloud** action. The default Trigger is `type = "page"` | Field | Description | Required | Type | | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------ | | Page View Properties | 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. | No | OBJECT | | User Fields | 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]\(https://help.encharge.io/article/206-create-and-manage-custom-fields). | No | OBJECT | | Type | The type of event. | Yes | STRING | | Email | The email address of the user. | No | STRING | | Anonymous ID | An anonymous identifier for this user. | No | STRING | | User ID | The User ID associated with the user in Encharge. | No | STRING | | Group ID | An ID associating the event with a group. | No | STRING | | Timestamp | The timestamp of the event | No | STRING | | MessageId | The Segment messageId | No | STRING | | IP Address | The IP address of the user. | No | STRING | | User Agent | The user agent of the user. Used to determine the device, browser and operating system. | No | STRING | | Campaign | UTM campaign information. | No | OBJECT | | Page | Information about the page where the event occurred. | No | OBJECT | | Location | Information about the location of the user. | No | OBJECT |