Dixa

Dixa is a customer service platform that unifies customer data and communication channels.

For more information about the API, see the Dixa API.

See the Schema section for a list of objects available for replication.

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling CDC for replication tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Make sure that the account you use has read access to the tables you want to fetch.

To generate the API token:

Log into your Dixa account.
Go to the Settings page.
Scroll to the Manage section and click Integrations.
In the API Tokens tab, click Add API token.
Give the API token a name, like Qlik Integration, to make it easy to find in your list of tokens.
Choose Dixa API as the API version.
Click Save changes
Copy the token.

Creating the connection

For more information, see Connecting to SaaS applications.

Fill in the required connection properties.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.
Click Create.

Connection settings
Setting	Description
Data gateway	Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.
Start Date	Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
API Token	API token.
Interval	Select the granularity of report time intervals from the drop-down list.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 1.

Depending on your destination, table and column names may not appear as they are outlined below.

activity_logs

The activity_logs lists all information from activity logs for an organization in your Dixa account.

Replication Method	CDC
Primary Key	id
Replication Key	activityTimestamp
Useful links	Dixa API method

Join activity_logs with	on
conversations	activity_logs.conversationId = conversations.id
messages	activity_logs.attributes.messageId = messages.id

_type

STRING

activityTimestamp

DATE-TIME

activityType

STRING

attributes

OBJECT

This is a nested data structure:

type: STRING
agent: OBJECT, which is also a nested data structure.
- email: STRING
- id: STRING
- name: STRING
- phoneNumber: STRING
agentid: STRING
agentName: STRING
agentNames: ARRAY
avatalUrl: STRING
avatarUrl: STRING
claimedFromLabel: STRING
claimedFromType: STRING
conversationSubject: STRING
destinationId: STRING
destinationLabel: STRING
destinationType: STRING
fromEndpoint: STRING
message: STRING
messageId: STRING
note: STRING
queueLabel: STRING
reason: STRING
subject: STRING
tag: STRING
tagAdded: STRING
templateName: STRING
transferType: STRING

author

OBJECT

This is a nested data structure:

email: STRING
id: STRING
name: STRING
phoneNumber: STRING

conversationId

INTEGER

STRING

conversations

The conversations table lists information about conversations in your Dixa account.

Replication Method	CDC
Primary Key	id
Replication Key	updated_at
Useful links	Dixa API method

Join conversations with	on
activity_logs	conversations.id = activity_logs.conversationId

anonymized_at

INTEGER

assigned_at

INTEGER

assignee_email

STRING

assignee_id

STRING

assignee_name

STRING

assignee_phone_number

STRING

closed_at

INTEGER

conversation_wrapup_notes

ARRAY

created_at

INTEGER

custom_fields

ARRAY

This is a nested data structure:

archived: BOOLEAN
attribute_id: STRING
data_type: STRING
identifier: STRING
value: STRING

direction

STRING

dixa_email_integration_id

STRING

dixa_email_integration_sender_name

STRING

facebook_page_id

STRING

facebook_page_name

STRING

forwarding_email

STRING

from_provisioned_phone_number_id

STRING

from_provisioned_phone_number_name

STRING

handling_duration

INTEGER

initial_channel

STRING

last_message_created_at

INTEGER

originating_country

STRING

queue_id

STRING

queue_name

STRING

queued_at

INTEGER

rating_message

STRING

rating_score

INTEGER

ratings

ARRAY

This is a nested data structure:

rating_cancelled_timestamp: STRING
rating_created_timestamp: INTEGER
rating_language: STRING
rating_message: STRING
rating_modified_timestamp: INTEGER
rating_offered_timestamp: INTEGER
rating_rated_timestamp: INTEGER
rating_scheduled_for_timestamp: INTEGER
rating_scheduled_timestamp: INTEGER
rating_score: INTEGER
rating_status: STRING
rating_type: STRING
rating_unscheduled_timestamp: STRING

requester_email

STRING

requester_id

STRING

requester_name

STRING

requester_phone_number

STRING

status

STRING

subject

STRING

tags

ARRAY

tags_info

ARRAY

This is a nested data structure:

id: STRING
is_deactivated: BOOLEAN
name: STRING

to_provisioned_phone_number_id

STRING

to_provisioned_phone_number_name

STRING

total_duration

INTEGER

transfer_time

INTEGER

transferee_name

STRING

transferee_number

STRING

updated_at

INTEGER

widget_id

STRING

widget_name

STRING

messages

The messages table contains information about all messages in your Dixa account.

Replication Method	CDC
Primary Key	id
Replication Key	created_at
Useful links	Dixa API method

Join messages with	on
activity_logs	messages.id = activity_logs.attributes.messageId

attached_files

ARRAY

author_email

STRING

author_name

STRING

bcc

ARRAY

chat_input_answer

STRING

chat_input_question

STRING

chat_menu_text

STRING

created_at

INTEGER

csid

INTEGER

direction

STRING

duration

INTEGER

from

STRING

from_phone_number

STRING

initial_channel

STRING

is_automated_message

BOOLEAN

recording_url

STRING

text

STRING

ARRAY

to_phone_number

STRING

voicemail_url

STRING

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here