Dixa Destination

Dixa
Create a Dixa Destination
-
Click the + icon on the Nexset that will be sent to the Dixa destination, and select the Send to Destination option from the menu.
-
Select the Dixa connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Dixa organisation, and click Next; or, create a new Dixa credential for use in this flow.
-
In Nexla, Dixa destinations can be created using pre-built endpoint templates, which expedite destination setup for common Dixa API endpoints. Each template is designed specifically for the corresponding Dixa endpoint, making destination configuration easy and efficient.
• To configure this destination using a template, follow the instructions in Configure Using a Template.Dixa destinations can also be configured manually, allowing you to send data to Dixa endpoints not included in the pre-built templates or apply further customisations 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 Dixa API endpoints. Each template is designed specifically for the corresponding Dixa 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.
Configure Manually
Dixa destinations can be manually configured to send data to any valid Dixa API endpoint. Manual configuration provides maximum flexibility for sending data to endpoints not covered by pre-built templates or when you need custom request body formatting, dynamic URL parameters, or advanced response handling.
Using manual configuration, you can also configure Nexla to automatically send the response received from the Dixa API after each call to a new Nexla webhook data source.
API Method
-
To manually configure this destination, select the Advanced tab at the top of the configuration screen.
-
Select the API method that will be used for calls to the Dixa API from the Method pulldown menu. Common Dixa API write methods include:
- POST: For creating new resources (conversations, end users, agents, queues, teams, tags, webhooks)
- PUT: For replacing or updating existing resources (closing conversations, claiming conversations, queue transfers)
- PATCH: For partial updates (updating agent profiles, queue settings, end user custom attributes)
- DELETE: For removing resources (deleting agents, queues, tags, webhook subscriptions)
Data Format
- Select the format in which the Nexset data will be sent to the Dixa API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Dixa API accepts JSON (
application/json) for all write operations.
API Endpoint URL
- Enter the URL of the Dixa API endpoint to which you want to send the Nexset data in the URL field. The Dixa API base URL is
https://dev.dixa.io/v1/. For update or delete operations on specific resources, append the resource ID at the end of the URL (for example,https://dev.dixa.io/v1/agents/{agentId}).
Request Headers
-
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).You do not need to include the
Authorizationheader or any other headers already present in the Dixa credential. The API key configured in your credential is automatically applied to every request.
Exclude Attributes from the Call
-
If any record attributes in the Nexset should be omitted when sending data to this Dixa destination, select the attributes from the Exclude Attributes pulldown menu.
-
Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.
Record Batching
-
If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.
-
Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to
100. -
Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.
Most Dixa API write endpoints accept a single record per request. Record batching is most useful with Dixa analytics query endpoints that support array-structured request bodies. Review the Dixa API documentation for the specific endpoint to confirm whether batch requests are supported before enabling this option.
Response Webhook
Nexla can automatically send the response received from the Dixa API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call — for example, capturing the newly created conversation ID or agent ID returned by Dixa after a create operation.
- To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.
Sample Request Payload
Sample request payloads containing a portion of the Nexset data that will be sent to the Dixa API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.
- Click on a sample request payload to expand it and view the complete payload content.
- Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.
Endpoint Testing (Manual Configuration)
After all endpoint settings have been configured, Nexla can send a test payload to the Dixa API to ensure that the destination is configured correctly.
-
To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.
-
If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.
-
Click the Send Test Data button at the top of a sample payload to send the test payload to the Dixa API using the current settings.
Save & Activate the Destination
-
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 data to the configured Dixa endpoint, open the destination resource menu, and select Activate.
The Nexset data will not be sent to the Dixa API until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.