Cue

Cue is a sales and customer service scripting platform that uses conversational intelligence to guide reps through calls with dynamic, real-time scripts. Its API provides access to calling campaigns and team data, enabling teams to integrate Cue activity into their data workflows.

Power end-to-end data operations for your Cue API with Nexla. Our bi-directional Cue connector is purpose-built for Cue, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Cue or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Cue workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Cue credential, you need to obtain your Cue API URL, User ID, Organization ID, Access Token, and Client ID from your Cue account. These values are required to authenticate with the Cue API using JWT/Token authentication.

To obtain your credentials, you need to have a Cue account with API access enabled. Once you have access to your account, you can generate an access token and obtain your User ID, Organization ID, and Client ID from your Cue account settings. Cue uses JWT/Token authentication with custom headers (X-Api-Consumer and X-Cue-UserId) and an Authorization header with a Bearer token. The access token is used to refresh the JWT token, which is then used to authenticate all API requests to the Cue API. For detailed information about API authentication and credential setup, refer to the Cue API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Cue API URL	Yes	No	Root URL of your Cue instance API
User ID	Yes	No	Your unique Cue user ID
Organization ID	Yes	No	The identifier for your Cue organization
Access token	Yes	Yes	Your individual access token generated in Cue
Client ID	Yes	No	The ID for your Cue application

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Cue

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter the root URL of your Cue instance API in the Cue API URL field. This should be the base URL for your Cue API instance (e.g., https://yourcuesite.com/api). The API URL is used to construct the full endpoint URLs for API requests.

   The Cue API URL should be the root URL of your Cue instance API, typically in the format https://yourcuesite.com/api where yourcuesite.com is your Cue instance domain. The API URL is used to construct the full endpoint URLs for API requests. For detailed information about determining your API URL, see the Cue API documentation.

4. Enter your unique Cue user ID in the User ID field. This is the unique identifier for your Cue user account. The User ID is sent in the X-Cue-UserId header for all API requests to the Cue API.

   The User ID is your unique Cue user identifier. The User ID is sent in the X-Cue-UserId header for all API requests to the Cue API. You can find your User ID in your Cue account settings.

5. Enter the identifier for your Cue organization in the Organization ID field. This is the unique identifier of your Cue organization.

   The Organization ID is the unique identifier for your Cue organization. You can find your Organization ID in your Cue account settings.

6. Enter your individual access token generated in Cue in the Access Token field. This is the access token you obtained from your Cue account. The access token is used to refresh the JWT token, which is then used to authenticate all API requests to the Cue API.

   Keep your access token secure and do not share it publicly. The access token provides access to your Cue account and should be treated as sensitive information. The access token is used to refresh the JWT token from the token refresh endpoint ({api_url}/v1/users/refresh-token), which is then used to authenticate all API requests to the Cue API. For detailed information about generating and managing access tokens, see the Cue API documentation.

7. Enter the ID for your Cue application in the Client ID field. This is the Client ID for your Cue application. The Client ID is sent in the X-Api-Consumer header for all API requests to the Cue API.

   The Client ID is the identifier for your Cue application. The Client ID is sent in the X-Api-Consumer header for all API requests to the Cue API. You can find your Client ID in your Cue account settings or application configuration.

8. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Cue connector tile, then select the credential that will be used to connect to the Cue instance, and click Next; or, create a new Cue credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Cue endpoints. 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.

Get Campaigns

This endpoint gets campaigns from your Cue account. Use this endpoint when you need to access campaign information, campaign data, or campaign lists from your Cue account.

• This endpoint automatically retrieves campaigns from your Cue account. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses GET requests to {api_url}/v1/campaigns?skip={skip}&take={take} where {api_url} is your Cue API URL from the credential configuration, {skip} is the pagination offset, and {take} is the page size. The endpoint URL is automatically constructed based on the Cue API base URL and pagination parameters.
• The endpoint uses offset-based pagination, automatically fetching additional pages as needed. Pagination starts from offset 0 (skip=0) and increments by the page size (take=25) for each subsequent page. Nexla will continue fetching pages until all campaigns are retrieved.
• The endpoint will return all campaigns. The response data is extracted from the root-level array in the API response ($[*]), with each campaign record processed individually.

This endpoint supports pagination through the skip/take mechanism. Pagination starts from offset 0 (skip=0) with a page size of 25 records per page (take=25). The endpoint uses offset-based pagination (iteration.type: paging.incrementing.offset) through the skip/take query parameters. The response data path is $[*], which extracts all items from the root-level array in the API response. For detailed information about getting campaigns, see the Cue API documentation.

Get Teams

This endpoint gets teams from your Cue account. Use this endpoint when you need to access team information, team data, or team lists from your Cue account.

• This endpoint automatically retrieves teams from your Cue account. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses GET requests to {api_url}/v1/teams?skip={skip}&take={take} where {api_url} is your Cue API URL from the credential configuration, {skip} is the pagination offset, and {take} is the page size. The endpoint URL is automatically constructed based on the Cue API base URL and pagination parameters.
• The endpoint uses offset-based pagination, automatically fetching additional pages as needed. Pagination starts from offset 0 (skip=0) and increments by the page size (take=25) for each subsequent page. Nexla will continue fetching pages until all teams are retrieved.
• The endpoint will return all teams. The response data is extracted from the root-level array in the API response ($[*]), with each team record processed individually.

This endpoint supports pagination through the skip/take mechanism. Pagination starts from offset 0 (skip=0) with a page size of 25 records per page (take=25). The endpoint uses offset-based pagination (iteration.type: paging.incrementing.offset) through the skip/take query parameters. The response data path is $[*], which extracts all items from the root-level array in the API response. For detailed information about getting teams, see the Cue API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Cue data sources can also be manually configured to ingest data from any valid Cue API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Cue API endpoints typically follow the pattern {api_url}/v1/{endpoint_path} where {api_url} is your Cue API URL from the credential configuration. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

The endpoint requires JWT/Token authentication with custom headers (X-Api-Consumer and X-Cue-UserId) and an Authorization header, which are handled automatically by your credential configuration. For a root-level array response, use $[*] as the path to data; use $ to extract the entire root-level object.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Cue 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.

Use as a destination

Click the + icon on the Nexset that will be sent to the Cue destination, and select the Send to Destination option from the menu. Select the Cue connector from the list of available destination connectors, then select the credential that will be used to connect to the Cue organization, and click Next; or, create a new Cue credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Cue endpoints. 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.

Save Contact

This endpoint saves contacts to your Cue account. Use this endpoint when you need to create or update contacts in your Cue account from your data sources.

• This endpoint automatically saves contacts to your Cue account. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses POST requests to {api_url}/v1/contacts where {api_url} is your Cue API URL from the credential configuration. The endpoint URL is automatically constructed based on the Cue API base URL.
• The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the contact data to save. The request body should follow the Cue API specification for saving contacts, including required fields and field names.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to save a contact. If you need to save multiple contacts, you can send multiple records, but each will be processed as a separate request.

The request body must be properly formatted JSON that matches the Cue API specification for saving contacts. The endpoint requires JWT/Token authentication with custom headers (X-Api-Consumer and X-Cue-UserId) and an Authorization header, which are handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about saving contacts, including required fields, field names, and request formats, see the Cue API documentation.

Save Account

This endpoint saves accounts to your Cue account. Use this endpoint when you need to create or update accounts in your Cue account from your data sources.

• This endpoint automatically saves accounts to your Cue account. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses POST requests to {api_url}/v1/accounts where {api_url} is your Cue API URL from the credential configuration. The endpoint URL is automatically constructed based on the Cue API base URL.
• The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the account data to save. The request body should follow the Cue API specification for saving accounts, including required fields and field names.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to save an account. If you need to save multiple accounts, you can send multiple records, but each will be processed as a separate request.

The request body must be properly formatted JSON that matches the Cue API specification for saving accounts. The endpoint requires JWT/Token authentication with custom headers (X-Api-Consumer and X-Cue-UserId) and an Authorization header, which are handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about saving accounts, including required fields, field names, and request formats, see the Cue API documentation.

Manual configuration

Cue destinations can also be manually configured to send data to any valid Cue API endpoint. Cue API endpoints typically follow the pattern {api_url}/v1/{endpoint_path} where {api_url} is your Cue API URL from the credential configuration, and the Cue API primarily uses POST requests for data writing operations. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

The endpoint requires JWT/Token authentication with custom headers (X-Api-Consumer and X-Cue-UserId) and an Authorization header, which are handled automatically by your credential configuration. You do not need to include any headers already present in the credentials; the Content-Type: application/json header is typically set automatically for JSON request bodies.

Save & activate

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 send the data to the configured Cue endpoint, open the destination resource menu, and select Activate.

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