Skip to main content

Encharge Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to an Encharge location.
encharge_api.png

Encharge

Create an Encharge Destination​

  1. Click the + icon on the Nexset that will be sent to the Encharge destination, and select the Send to Destination option from the menu.

  2. Select the Encharge connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Encharge organization, and click Next; or, create a new Encharge credential for use in this flow.

  3. In Nexla, Encharge destinations can be created using pre-built endpoint templates, which expedite destination setup for common Encharge endpoints. Each template is designed specifically for the corresponding Encharge endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Encharge destinations can also be configured manually, allowing you to send data to Encharge endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Encharge endpoints. Each template is designed specifically for the corresponding Encharge endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create or Update Person

    Creates or updates a person (contact) record in Encharge. Records are upserted based on the id, userId, or email field in the incoming data — if a matching person is found, their record is updated; otherwise, a new person is created. Use this endpoint to synchronize contact data from external systems into Encharge.

    • Ensure that each record in the Nexset includes at least one of the following identifier fields: email, userId, or id. These fields are used by Encharge to match incoming records to existing contacts. If none of these identifiers are present, Encharge will create a new person record for the incoming data.
    • The full incoming record body is sent as the person payload to Encharge. Any fields in the Nexset that correspond to standard or custom Encharge person attributes will be mapped and saved automatically.
    • This endpoint sends one record per API call (batch mode is disabled). For high-volume data loads, consider using the manual configuration with record batching enabled.

    For complete information on the fields accepted by the Encharge People API, refer to the Encharge API Reference — POST /people.

    Add Tag to Person

    Adds one or more tags to an existing person in Encharge. Tags are used in Encharge to categorize contacts, trigger automation flows, and build audience segments. Use this endpoint to apply tags from external systems or workflow outputs to Encharge contacts.

    • Ensure that each record in the Nexset includes the following required fields:

      • tag: The name of the tag (or a comma-separated list of tag names for multiple tags) to add to the person.
      • At least one person identifier: email, userId, or id. Encharge uses this identifier to locate the person to whom the tag(s) will be added.
    • To add multiple tags to a single person in one call, include all tag names as a comma-separated value in the tag field (e.g., paid-customer,onboarded,active).
    • This endpoint sends one record per API call. The tag is added to the person's existing tag list — any tags already assigned to the person are preserved.

    For complete information on the Encharge Tags API, refer to the Encharge API Reference — POST /tags.

    Remove Tag from Person

    Removes one or more tags from an existing person in Encharge. Use this endpoint to programmatically clean up tags, update contact classification, or respond to downstream events that should modify a contact's tag assignments.

    • Ensure that each record in the Nexset includes the following required fields:

      • tag: The name of the tag (or a comma-separated list of tag names for multiple tags) to remove from the person.
      • At least one person identifier: email, userId, or id. Encharge uses this identifier to locate the person from whom the tag(s) will be removed.
    • To remove multiple tags from a single person in one call, include all tag names as a comma-separated value in the tag field.
    • This endpoint sends one record per API call (DELETE method). Only the specified tags are removed — all other tags on the person's record are preserved.

    For complete information on the Encharge Tags API, refer to the Encharge API Reference — DELETE /tags.

    Create Custom Object

    Creates a custom object record (such as a company, invoice, or other structured entity) under a specified object schema in Encharge. Use this endpoint to populate Encharge with structured business data from external systems for use in segmentation, personalization, and automation workflows.

    • Enter the name of the custom object schema to write into in the Object Name field. This is a required parameter. The object name must exactly match an existing schema defined in your Encharge account (e.g., company, invoice).

    • Available object schema names can be found in your Encharge account by using the List Schemas source endpoint, or by navigating to the custom objects section of the Encharge dashboard.

      • The object name is case-sensitive and must match the schema name exactly as it was defined in Encharge.
    • The full incoming record body is sent as the custom object payload to Encharge. Ensure that the Nexset fields match the attributes defined in the target object schema.

    For complete information on creating custom objects in Encharge, refer to the Encharge API Reference — POST /objects/{objectName}.

    Track Event

    Tracks a behavioral event for a person via the Encharge Ingest API. Events submitted through this endpoint trigger automation flows, update contact scoring, and enable event-based segmentation in Encharge. Use this endpoint to send product usage events, purchase events, or custom behavioral signals from external systems into Encharge.

    • This endpoint requires the Ingest API Write Key Authentication credential type. The Track Event endpoint sends data to a separate Encharge Ingest API (https://ingest.encharge.io/v1) rather than the standard REST API, and uses a different authentication key. Ensure you have created an Ingest API Write Key credential before configuring this destination.

    • Structure each record in the Nexset to include the required Encharge Ingest API event fields:

      • name: The name of the event to track (e.g., Signed Up, Upgraded Plan, Feature Used). Use identify as the event name to create or update a person record rather than track a behavioral event.
      • userId or email: An identifier for the person associated with the event.
    • Additional event properties (such as plan name, feature ID, or purchase amount) can be included as additional fields in the record and will be passed through to Encharge as event properties, where they can be used in automation triggers and segmentation rules.

    Events tracked via this endpoint will trigger any Encharge automation flows that use the corresponding event as a trigger. For complete information on the Encharge Ingest API, refer to the Encharge Ingest API documentation.

Configure Manually​

Encharge destinations can be manually configured to send data to any valid Encharge API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Encharge API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Encharge API from the Method pulldown menu. Common methods for Encharge destination operations include:

    • POST: For creating new records (people, tags, events, custom objects)
    • PUT: For replacing existing records
    • PATCH: For partial updates to existing records
    • DELETE: For removing records or associations (e.g., removing tags)

Data Format​

  1. Select the format in which the Nexset data will be sent to the Encharge API from the Content Format pulldown menu. Encharge APIs accept data in JSON format — select application/json as the content format. Nexla will automatically convert the data to JSON for each API call.

API Endpoint URL​

  1. Enter the URL of the Encharge API endpoint to which you want to send the Nexset data in the URL field. For update/upsert operations, include the ID of the object to be updated at the end of the URL. Encharge REST API endpoints follow the base URL pattern https://api.encharge.io/v1/, and Ingest API endpoints use https://ingest.encharge.io/v1.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include the X-Encharge-Token authentication header. This header is automatically included by Nexla based on your configured Encharge credential.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Encharge destination, select the attributes from the Exclude Attributes pulldown menu. This is useful when the Nexset contains internal metadata or processing fields that should not be sent to Encharge.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the Encharge API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call, such as the newly created or updated record's ID.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Encharge API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Encharge API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Encharge API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to Encharge, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to Encharge until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.