Customerly Data Source

The Customerly connector enables you to ingest data from your Customerly workspace into Nexla, including users, leads, accounts, tags, knowledge base collections and articles, and writer profiles. Follow the instructions below to create a new data flow that ingests data from a Customerly source in Nexla.

Customerly

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 Customerly connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Customerly instance, and click Next; or, create a new Customerly credential for use in this flow.

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

   Customerly sources can also be configured manually, allowing you to ingest data from Customerly 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 Customerly endpoints. Each template is designed specifically for the corresponding Customerly 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 Users

Returns a paginated list of all users in your Customerly workspace. Use this endpoint when you need to export or analyze your full user base, including their contact details, attributes, and subscription status.

• This endpoint automatically retrieves all users in your account using page-based pagination. Nexla fetches pages incrementally (50 records per page by default) until no further results are returned.
• No additional parameters are required beyond selecting this endpoint template.

Users in Customerly are contacts who have been identified by their user ID or email address — typically authenticated customers of your product. To retrieve anonymous visitors, use the List Leads endpoint instead.

List Leads

Returns a paginated list of all leads in your Customerly workspace. Leads are anonymous or unidentified visitors who have interacted with your chat widget but have not yet been identified as users.

• This endpoint automatically retrieves all leads using page-based pagination. Nexla fetches pages incrementally (50 records per page by default) until no further results are returned.
• No additional parameters are required beyond selecting this endpoint template.

Once a lead is converted or identified, they become a user in Customerly. Use this endpoint to analyze pre-conversion contact data or track lead volume over time.

Get User by Email

Returns full profile details for a single Customerly user identified by their email address. Use this endpoint when you need to look up a specific user's data for enrichment, verification, or targeted processing.

• Enter the email address of the user to look up in the Email field. This is a required parameter.

  • The email address must match exactly the email stored in Customerly for the user.
  • The response returns the full user profile, including custom attributes, subscription status, and company associations.

This endpoint returns a single user record rather than a paginated list. It is best suited for targeted lookups or when building flows that process individual users based on a known email address.

Get User by ID

Returns full profile details for a single Customerly user identified by their user ID. Use this endpoint when you have a Customerly user ID and need to retrieve all associated data for that user.

• Enter the unique identifier of the user in the User ID field. This is a required parameter.

  • The user ID is the identifier you assigned to the user when they were created in Customerly (typically your internal application user ID).
  • The response returns the full user profile, including custom attributes, subscription status, and company associations.

This endpoint returns a single user record. Use it in flows where you already have a known user ID, such as when joining Customerly user data with records from another system.

List Accounts

Returns the list of accounts (admins and teammates) in your Customerly workspace. Use this endpoint to retrieve information about the support agents and team members who manage your Customerly inbox.

• This endpoint retrieves all accounts in a single request without pagination. No additional configuration is required beyond selecting this endpoint template.
• The response includes each account's ID, name, email address, role, and avatar information.

Accounts represent the internal team members of your Customerly workspace — not your customers. Use this endpoint to sync agent rosters or audit team membership.

Get Lead by Email

Returns full profile details for a single Customerly lead identified by their email address. Use this endpoint when you need to look up a specific lead for enrichment or targeted processing.

• Enter the email address of the lead in the Email field. This is a required parameter.

  • The email address must match exactly the email stored in Customerly for the lead.
  • The response returns the full lead profile, including any collected attributes and conversation history.

This endpoint returns a single lead record. It is best suited for targeted lookups when you have a specific lead's email address and need to retrieve their associated data.

List Tags

Returns the list of all tags defined in your Customerly workspace. Tags are labels that can be applied to users and leads to organize and segment your contacts.

• This endpoint retrieves all tags in a single request without pagination. No additional configuration is required beyond selecting this endpoint template.
• The response includes each tag's ID, name, and associated metadata.

Use this endpoint to audit your tag taxonomy, synchronize tags to external systems, or build flows that enrich contact records with tag information.

List Knowledge Base Collections

Returns the list of all knowledge base collections in your Customerly workspace. Collections are top-level categories that group related knowledge base articles.

• This endpoint retrieves all collections in a single request without pagination. No additional configuration is required beyond selecting this endpoint template.
• The response includes each collection's ID, title, description, icon, and slug.

Use this endpoint to replicate your knowledge base structure to an external system or to build flows that process articles grouped by collection.

Get Knowledge Base Collection

Returns details for a single knowledge base collection identified by its ID. Use this endpoint when you need to retrieve complete metadata for a specific collection.

• Enter the unique identifier of the collection in the Collection ID field. This is a required parameter.

  • Collection IDs can be found by first using the List Knowledge Base Collections endpoint to retrieve all collections and their corresponding IDs.
  • The response returns the full collection record, including title, description, icon, and slug.

This endpoint returns a single collection record. Use it when you already have a known collection ID and need to retrieve or validate its metadata.

List Knowledge Base Articles

Returns the list of all knowledge base articles in your Customerly workspace. Use this endpoint to export your entire knowledge base content for analysis, backup, or synchronization with an external system.

• This endpoint retrieves all articles in a single request without pagination. No additional configuration is required beyond selecting this endpoint template.
• The response includes each article's ID, title, body content, collection association, slug, and publication status.

Use this endpoint to replicate your knowledge base content to an external CMS, data warehouse, or search index.

Get Knowledge Base Article

Returns details for a single knowledge base article identified by its ID. Use this endpoint when you need to retrieve the full content and metadata for a specific article.

• Enter the unique identifier of the article in the Article ID field. This is a required parameter.

  • Article IDs can be found by first using the List Knowledge Base Articles endpoint to retrieve all articles and their corresponding IDs.
  • The response returns the full article record, including title, body content, collection ID, slug, and publication status.

This endpoint returns a single article record. Use it when you already have a known article ID and need to retrieve or validate its content.

List Knowledge Base Writers

Returns the list of knowledge base writers (authors) in your Customerly workspace. Writers are the team members who have contributed articles to your knowledge base.

• This endpoint retrieves all writers in a single request without pagination. No additional configuration is required beyond selecting this endpoint template.
• The response includes each writer's ID, name, and associated profile information.

Use this endpoint to identify and sync knowledge base authors, or to enrich article records with author profile information from your Customerly workspace.

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

Customerly data sources can be manually configured to ingest data from any valid Customerly 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 Customerly 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 Customerly API from the Method pulldown menu. The most common methods are:

   • GET: For retrieving data from the API
   • POST: For sending data to the API or triggering actions
   • PUT: For updating existing data
   • PATCH: For partial updates to existing data
   • DELETE: For removing data

API Endpoint URL

3. Enter the URL of the Customerly API endpoint from which this source will fetch data in the Set API URL field. The Customerly REST API base URL is https://api.customerly.io/v1/, followed by the resource path (for example, https://api.customerly.io/v1/users/list).

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. Full API endpoint documentation is available via the Customerly REST 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 Customerly endpoints that accept date range parameters, allowing you to incrementally fetch only new or updated records between runs.

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 create Customerly API endpoints that reference specific IDs or values from other data sources in your Nexla environment — for example, using a list of user IDs retrieved from one source to fetch detailed records from another.

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 the Customerly API endpoint is needed, you can designate the part of the response that should be included in the Nexsets produced from this source by specifying the path to the relevant data within the response.

For example, the Customerly API typically returns paginated lists nested under a data key (e.g., $.data.users[*] for the List Users endpoint or $.data[*] for tag and account endpoints). By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when Customerly API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

• 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.users[*] to access the users array within a data object).
  Path to Data Example:

  The Customerly List Users endpoint returns JSON where users are nested as $.data.users[*], while endpoints such as List Tags and List Accounts return arrays directly at $.data[*]. Single-record endpoints (such as Get User by Email) return the object at $.data.

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 Customerly API 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.

For example, the Customerly API often includes pagination context (such as total record counts) at the top level of a response. If you have specified the path to the user array but also want to capture the total user count, you can specify a path to the metadata to include it with each record.

Metadata paths are particularly useful for preserving API response context like total counts, page numbers, or request timestamps that apply to all records in the 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).

  You do not need to include the Authentication header — Nexla automatically includes your Customerly Bearer token from the configured credential in all API requests.

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