Extole

Extole is the customer-led growth platform for marketers with scalable referral marketing and customer engagement solutions.

Power end-to-end data operations for your Extole API with Nexla. Our bi-directional Extole connector is purpose-built for Extole, 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 Extole or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Extole 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 an Extole credential, you need to obtain your Client Domain from your Extole account. The Client Domain is required to authenticate with the Extole API.

To obtain your Client Domain, you need to have an Extole account with API access enabled. Once you have access to your account, you can find your Client Domain from your Extole account settings or from your Extole URL. The Client Domain is your Extole client domain (e.g., yourcompany for yourcompany.extole.io). Nexla uses token-based authentication to automatically obtain an access token for API requests. The access token is then sent in the Authorization header with the Bearer prefix for all API requests to the Extole API. For detailed information about API credential setup and authentication, refer to the Extole API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Client domain	Yes	No	Client domain of the user account

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 – Extole

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

3. Enter your Extole Client Domain in the Client domain field. This is your Extole client domain (e.g., yourcompany for yourcompany.extole.io). The Client Domain is used to construct the API base URL for your account (e.g., https://{client_domain}.extole.io/api/v4).

   The Client Domain is your Extole client domain without the .extole.io suffix. For example, if your Extole URL is https://yourcompany.extole.io, your Client Domain would be yourcompany. The Client Domain is used to construct the API base URL for your account. Nexla uses token-based authentication to automatically obtain an access token for API requests. For detailed information about finding your Client Domain and authentication, see the Extole API documentation.

4. 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 Extole connector tile, then select the credential that will be used to connect to the Extole instance, and click Next; or, create a new Extole 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 Extole 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 User History

This endpoint fetches user history such as shares and rewards. Use this endpoint when you need to access user activity data, share history, or reward history from your Extole account.

• Select the history type you want to retrieve from the History Type dropdown menu. Available options are:

  • shares: Returns the user with a history of all their shares (default)
  • rewards: Returns the user with a history of all their earned rewards

  The default value is shares if not specified.

• The endpoint uses GET requests to https://{client_domain}.extole.io/api/v5/{history_type} where {client_domain} is your Client Domain from the credential configuration and {history_type} is the History Type you select. The endpoint URL is automatically constructed based on your Extole API base URL and the history type.
• The endpoint does not use pagination and returns all user history of the specified type in a single request.
• The endpoint will return all user history of the specified type. The response data is extracted from the root-level array in the API response ($[*]), with each history record processed individually.

The History Type parameter determines which type of user history to retrieve. The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $[*], which extracts all items from the root-level array in the API response. For detailed information about getting user history, see the Extole 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

Extole data sources can also be manually configured to ingest data from any valid Extole API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. 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.

Extole API endpoints typically follow the pattern https://{client_domain}.extole.io/api/v{version}/{endpoint_path}, where {client_domain} is your Client Domain from the credential configuration. The endpoint requires token-based authentication via the Authorization: Bearer {token} header, which Nexla handles automatically using your credential configuration.

Once all of the relevant settings have been configured, click the Save button to save and create the new Extole data source. The data source will now be available in your data flow and will begin ingesting data according to the configured schedule and endpoint settings.

Use as a destination

Click the + icon on the Nexset that will be sent to the Extole destination, and select the Send to Destination option from the menu. Select the Extole connector from the list of available destination connectors, then select the credential that will be used to connect to the Extole organization, and click Next; or, create a new Extole 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 Extole 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.

Create Email Share

This endpoint allows the user to send a share email through Extole. Use this endpoint when you need to send share emails from your data sources to your Extole account.

• This endpoint automatically sends share emails through Extole. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses POST requests to https://{client_domain}.extole.io/api/v6/email/share where {client_domain} is your Client Domain from the credential configuration. The endpoint URL is automatically constructed based on your Extole 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 email share data. The request body should follow the Extole API specification for creating email shares, 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 send an email share. If you need to send multiple email shares, you can send multiple records, but each will be processed as a separate request.
• This endpoint automatically creates a data source to track the responses received from the Extole API after each call.

The request body must be properly formatted JSON that matches the Extole API specification for creating email shares. The endpoint requires token-based authentication via the Authorization: Bearer {token} header, which is handled automatically by Nexla. Nexla automatically obtains an access token using 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. This endpoint automatically creates a data source (create.datasource: true) to track responses. For detailed information about creating email shares, including required fields, field names, and request formats, see the Extole API documentation.

Create Batch Email Share

This endpoint allows the user to send a batch of share emails through Extole. Use this endpoint when you need to send multiple share emails in a batch from your data sources to your Extole account.

• This endpoint automatically sends batch share emails through Extole. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses POST requests to https://{client_domain}.extole.io/api/v6/email/share/batch where {client_domain} is your Client Domain from the credential configuration. The endpoint URL is automatically constructed based on your Extole 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 batch email share data. The request body should follow the Extole API specification for creating batch email shares, 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 send a batch of email shares. If you need to send multiple batches, you can send multiple records, but each will be processed as a separate request.
• This endpoint automatically creates a data source to track the responses received from the Extole API after each call.

The request body must be properly formatted JSON that matches the Extole API specification for creating batch email shares. The endpoint requires token-based authentication via the Authorization: Bearer {token} header, which is handled automatically by Nexla. Nexla automatically obtains an access token using 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. This endpoint automatically creates a data source (create.datasource: true) to track responses. For detailed information about creating batch email shares, including required fields, field names, and request formats, see the Extole API documentation.

Manual configuration

Extole destinations can also be manually configured to send data to any valid Extole API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations. Using manual configuration, you can also configure Nexla to automatically send the response received from the Extole API after each call to a new Nexla webhook data source. 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, and request body.

Extole API endpoints typically follow the pattern https://{client_domain}.extole.io/api/v{version}/{endpoint_path}, where {client_domain} is your Client Domain from the credential configuration. The endpoint requires token-based authentication via the Authorization: Bearer {token} header, which Nexla handles automatically using your credential configuration. The Content-Type: application/json header is typically set automatically for JSON request bodies.

Save & activate

Once all configuration steps have been completed, click the Save button to save and create the new Extole destination. The destination will now be available in your data flow and will begin sending data to the Extole endpoint according to the configured settings.