Skip to main content

Extole Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a sync or streaming data flow that sends data to an Extole location.
extole_api.png

Extole

Create an Extole Destination​

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

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

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

    Extole destinations can also be configured manually, allowing you to send data to Extole 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 Extole endpoints. Each template is designed specifically for the corresponding Extole 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 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.

Configure Manually​

Extole destinations can 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.

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 Extole API from the Method pulldown menu. The Extole API primarily uses POST requests for data writing operations. The most common methods are:

    • POST: For creating new resources or performing actions (e.g., creating email shares, creating batch email shares)
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

Data Format​

  1. Select the format in which the Nexset data will be sent to the Extole API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Extole API typically uses JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the Extole API endpoint to which you want to send the Nexset data in the URL field. This should be the complete URL including the protocol (https://) and any required path parameters. 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.

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. 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. For detailed information about Extole API endpoints and available APIs, see the Extole API documentation.

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). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include any headers already present in the credentials. Common headers like Authorization, Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration. The Extole API requires token-based authentication via the Authorization: Bearer {token} header, which is handled automatically by Nexla. The Content-Type: application/json header is typically set automatically for JSON request bodies.

Request Body​

Optional

  • If the API endpoint requires a specific request body format, configure how Nexla should format the request body from your Nexset data. The request body can be sent as JSON, XML, or form data, depending on the API endpoint requirements.

    • For JSON format, select JSON from the Request Body Format dropdown, and the Nexset data will be sent as a JSON object in the request body. Extole API endpoints typically use JSON format for request bodies.

    • For XML format, select XML from the Request Body Format dropdown, and the Nexset data will be converted to XML format in the request body.

    • For Form data format, select Form Data from the Request Body Format dropdown, and the Nexset data will be sent as form-encoded data in the request body.

Save the Destination​

  1. Once all configuration steps have been completed, click the Save button to save your destination configuration.

  2. The destination will now be available in your data flow and will begin sending data to the Extole endpoint according to the configured settings.