Encharge Data Source

The Encharge connector enables you to ingest contact, account, segment, tag, field, schema, and custom object data from your Encharge marketing automation account. Follow the instructions below to create a new data flow that ingests data from an Encharge source in Nexla.

Encharge

Create a New Data Flow

1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

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

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

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

Configure Using a Template

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

Endpoint Settings

• Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

  List People

  Returns a list of all people (contacts) in your Encharge account. Use this endpoint to export your full contact database for analysis, synchronization with other systems, or CRM workflows.

  • This endpoint retrieves all people records stored in your Encharge account. No additional parameters are required — select this endpoint and Nexla will fetch all available contacts.
  • Each returned record represents a single person and includes all attributes stored in Encharge, such as email address, name, tags, segment membership, and any custom fields defined in your account.

  For complete information on the Encharge People API, refer to the Encharge API Reference.

  List Accounts

  Returns a list of all accounts in your Encharge system. Use this endpoint to retrieve company-level records for B2B workflows, CRM synchronization, or account-based marketing analysis.

  • This endpoint retrieves all account records from Encharge. No additional parameters are required — select this endpoint to fetch all available account data.
  • Each record represents a single account and includes account attributes such as the account name, domain, associated people, and any custom account fields configured in Encharge.

  List Account Tags

  Returns a list of all tags available for tag management in your Encharge account. Use this endpoint to audit your tag library, synchronize tags with external systems, or build tag-based reporting.

  • This endpoint retrieves all tags defined in your Encharge account. No additional parameters are required.
  • Tags in Encharge are labels applied to people records to categorize contacts, trigger automation flows, and drive segmentation. The returned data includes each tag name and associated metadata.

  List Segments

  Returns a list of all segments in your Encharge account. Use this endpoint to review your audience segments, monitor segment definitions, or integrate segment metadata with external analytics tools.

  • This endpoint retrieves all segment definitions from Encharge. No additional parameters are required.
  • Segments in Encharge are dynamic or static groupings of contacts based on behavior, attributes, or events. The returned records include segment names, IDs, and configuration details that can be used with other endpoints such as List Segment People.

  Segment IDs returned by this endpoint can be used as input for the List Segment People and List Custom Objects in Segment endpoints.

  List Fields

  Returns a list of all custom fields defined in your Encharge account. Use this endpoint to audit your contact data model, build field mappings for integrations, or understand the structure of your people records.

  • This endpoint retrieves all custom field definitions from Encharge. No additional parameters are required.
  • Custom fields extend the default Encharge person record with additional attributes specific to your business — for example, plan type, trial start date, or company size. The returned data includes field names, types, and identifiers.

  List Schemas

  Returns a list of all data schemas (custom object types) available in your Encharge account. Use this endpoint to discover what custom object types are defined before using the List Custom Objects or Create Custom Object endpoints.

  • This endpoint retrieves all custom object schema definitions from Encharge. No additional parameters are required.
  • Custom object schemas define the structure of non-person data in Encharge — for example, companies, invoices, or subscriptions. The schema name returned here (e.g., company, invoice) is used as a required parameter in the List Custom Objects and List Custom Objects in Segment endpoints.

  Use the object names returned by this endpoint as the Object Name parameter value when configuring the List Custom Objects or List Custom Objects in Segment endpoint templates.

  List Segment People

  Returns a list of all people (contacts) that belong to a specific Encharge segment. Use this endpoint to export audience subsets for targeted analysis, campaign reporting, or synchronization with downstream tools.

  • Enter the ID of the segment whose members you want to retrieve in the Segment ID field. This is a required parameter.

    • Segment IDs can be obtained by first running the List Segments endpoint, which returns a list of all segments in your account along with their IDs.
  • This endpoint supports paginated retrieval using offset-based pagination, automatically fetching all pages of results until the full segment membership list has been retrieved.

  Large segments may return many records across multiple pages. Nexla handles pagination automatically — no additional configuration is required to retrieve all records.

  Get Account Info

  Returns information about the current Encharge account, including the total people count, account status, timezone, site URL, active services, and account ID. Use this endpoint to monitor account health or retrieve account metadata for reporting.

  • This endpoint retrieves account-level metadata for the authenticated Encharge account. No additional parameters are required.
  • The response is a single JSON object (not an array) containing account details. This makes it particularly useful as a quick health check or for populating account-level metadata in dashboards.

  List Tag Counts

  Returns all tags in your Encharge account along with the count of people tagged with each tag. Use this endpoint to analyze tag distribution, monitor audience size by tag, and generate tag-based engagement reports.

  • This endpoint retrieves all tags and their associated people counts from Encharge. No additional parameters are required.
  • Each record in the response includes a tag name and a count of how many contacts currently carry that tag, making this endpoint ideal for building dashboards that track audience segmentation and tag usage over time.

  List Email Domains

  Returns all email sending domains configured for your Encharge account, including their verification status. Use this endpoint to monitor domain configuration, audit sending infrastructure, or verify that domains are properly authenticated for email delivery.

  • This endpoint retrieves all email domains registered in your Encharge account settings. No additional parameters are required.
  • The response includes each domain name and its verification status (e.g., verified or pending). Domains must be verified in Encharge before they can be used for email sending.

  List Custom Objects

  Returns a list of custom object records (such as companies or invoices) for a given object schema in Encharge. Use this endpoint to export structured business data associated with your contacts for analysis or downstream integration.

  • Enter the name of the custom object schema whose records you want to retrieve in the Object Name field. This is a required parameter. The object name must match an existing schema in your Encharge account (e.g., company, invoice).

    • Available schema names can be discovered by first running the List Schemas endpoint.
  • This endpoint supports paginated retrieval using offset-based pagination with a default page size of 100 records per request. Nexla handles pagination automatically to retrieve all available records.

  Custom objects in Encharge allow you to store non-person data (such as company records, subscription details, or invoices) and associate them with people and segments. The object schema name is case-sensitive and must exactly match the schema name as defined in Encharge.

  List Custom Objects in Segment

  Returns custom object records (such as companies) that belong to a specific Encharge segment. Use this endpoint to retrieve structured business data filtered by segment membership for targeted analysis or reporting.

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

    • Available schema names can be discovered by first running the List Schemas endpoint.

  • Enter the ID of the segment to filter custom objects by in the Segment ID field. This is a required parameter.

    • Segment IDs can be obtained by first running the List Segments endpoint.
  • This endpoint supports paginated retrieval with a default page size of 100 records. Nexla handles pagination automatically.

  List Email Template Versions

  Returns the version history of a specific email template in Encharge. Use this endpoint to track template changes over time, audit content revisions, or export version data for compliance and governance workflows.

  • Enter the ID of the email template whose version history you want to retrieve in the Email Template ID field. This is a required parameter.
  • The endpoint returns each saved version of the specified email template, including version content and metadata. It supports paginated retrieval with a default page size of 50 records per request.

  Email template IDs can be found in the Encharge dashboard under your email templates, or through the Encharge API. Refer to the Encharge API Reference for additional details on email template management.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

Encharge data sources can be manually configured to ingest data from any valid Encharge API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Encharge sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

API Method

1. To manually configure this source, 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. The most common methods are:

   • GET: For retrieving data from the API — used by all Encharge source endpoints
   • POST: For sending data to the API or triggering actions

API Endpoint URL

3. Enter the URL of the Encharge API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Encharge REST API endpoints follow the base URL pattern https://api.encharge.io/v1/.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. For a full list of available Encharge API endpoints, refer to the Encharge API Reference.

Date/Time Macros (API URL)

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Macros are particularly useful for Encharge API endpoints that accept date range parameters, enabling you to automatically fetch only the records updated or created within a specific time window on each run.

1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

   • {now} – The current datetime
   • {now-1} – The datetime one time unit before the current datetime
   • {now+1} – The datetime one time unit after the current datetime
   • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when you need to construct Encharge API endpoint URLs that reference specific segment IDs, object schema names, or other identifiers retrieved from other Nexla data sources.

1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data

Optional

If only a subset of the data returned by an Encharge API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or wrapper objects that you don't need for your analysis.

For example, the Encharge List People endpoint returns records nested under $.data[*], while the List Segments endpoint nests records under $.segments[*]. By entering the correct path, Nexla will treat each element of the returned array as an individual record.

Specifying the correct Path to Data is important for Encharge responses that wrap their primary data arrays inside named properties. Without the correct path, Nexla may treat the entire response wrapper as a single record rather than parsing individual items.

• To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

  • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.data[*] for the people list, $.segments[*] for segments, $.tags[*] for tags).
  Path to Data Examples:

  Encharge endpoints use different response structures. Common path values include: $.data[*] for people, $.segments[*] for segments, $.tags[*] for tags, $.tagCounts[*] for tag counts, $.objects[*] for custom objects and schemas, and $.items[*] for fields.

Autogenerate Path Suggestions

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

• To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

• Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

  

Metadata

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

Metadata paths are particularly useful for preserving API response context like request IDs, timestamps, or summary statistics that apply to all records in the Encharge response.

• To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

  • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers may be required for API versioning or custom authentication requirements.

  You do not need to include the X-Encharge-Token authentication header or any other headers already present in the credentials. These are handled automatically by Nexla based on your credential configuration.

Endpoint Testing

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source

1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Encharge data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.