Dixa (v1) | Stitch Documentation

Dixa is in beta
Dixa is currently in beta. The info in this guide is subject to change.

Dixa is supported by Stitch
This integration is powered by Singer's Dixa tap and certified by Stitch. Check out and contribute to the repo on GitHub.

For support, contact Stitch support.

Dixa integration summary

Stitch’s Dixa integration replicates data using the Dixa API. Refer to the Schema section for a list of objects available for replication.

Dixa feature snapshot

A high-level look at Stitch's Dixa (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status	Beta	Supported by	Stitch
Stitch plan	Standard	API availability	Available
Singer GitHub repository	singer-io/tap-dixa
REPLICATION SETTINGS
Anchor Scheduling	Supported	Advanced Scheduling	Supported
Table-level reset	Unsupported	Configurable Replication Methods	Unsupported
DATA SELECTION
Table selection	Supported	Column selection	Supported
Select all	Supported
TRANSPARENCY
Extraction Logs	Supported	Loading Reports	Supported

Connecting Dixa

Step 1: Generate a Dixa API token

Log into your Dixa account.
Go to Settings page.
Scroll to the Manage section and then click **Integrations”.
In the API Tokens card, click Configure API tokens.
Click Add API Token.
Give the API token a name, like Stitch Integration, to make it easy to find in your list of tokens. Choose Dixa API as the API version. Click Add API Token.
Copy the API token, and have it readily available for the next step.

Step 2: Add Dixa as a Stitch data source

Sign into your Stitch account.
On the Stitch Dashboard page, click the Add Integration button.
Click the Dixa icon.
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

For example, the name “Stitch Dixa” would create a schema called stitch_dixa in the destination. Note: Schema names cannot be changed after you save the integration.
In the API Token field, paste the API token you copied from step 1.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Dixa integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Dixa’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the Replication Scheduling documentation for more information.

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Dixa integrations support the following replication scheduling methods:

Replication Frequency
Anchor Scheduling
Advanced Scheduling using Cron (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5: Set objects to replicate

Is an object missing or not replicating? Verify that the object meets the requirements for selection and replication.

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For Dixa integrations, you can select:

Individual tables and columns
All tables and columns

Click the tabs to view instructions for each selection method.

In the integration’s Tables to Replicate tab, locate a table you want to replicate.
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
Repeat this process for all the tables and columns you want to replicate.
When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Important: Using the Select All feature will overwrite any previous selections. However, selections aren’t final until Finalize Your Selections is clicked. Clicking Cancel will restore your previous selections. Refer to the Select All guide for more info about this feature.

Click into the integration from the Stitch Dashboard page.
Click the Tables to Replicate tab.
In the list of tables, click the box next to the Table Names column.
In the menu that displays, click Track all Tables and Fields:
Click the Finalize Your Selections button at the bottom of the page to save your data selections.

Initial and historical replication jobs

After you finish setting up Dixa, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Initial replication jobs with Anchor Scheduling

If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Replication will continue after the seven days are over. If you’re no longer interested in this source, be sure to pause or delete the integration to prevent unwanted usage.

Dixa table reference

Schemas and versioning

Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.

The schema and info displayed below is for version 1 of this integration.

This is the latest version of the Dixa integration.

Table and column names in your destination

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

For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.

activity_logs

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	activityTimestamp
Primary Key :	id	API endpoint :	List organization activity log

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

activity_logs table schema

id
STRING

The activity ID.

activityTimestamp
DATE-TIME

The time the activity happened.

activityType
STRING

attributes
OBJECT

Click to expand attributes

agent
OBJECT

Click to expand agent

id
STRING

name
STRING

email
STRING

phoneNumber
STRING

activity_logs (table), agent (attribute)

agentNames
ARRAY

Click to expand agentNames

items
STRING

activity_logs (table), agentNames (attribute)

agentId
STRING

agentName
STRING

templateName
STRING

conversationSubject
STRING

messageId
STRING

The message ID.

Reference:

messages.id
activity_logs.attributes.messageId

fromEndpoint
STRING

avatarUrl
STRING

tagAdded
STRING

note
STRING

activity_logs (table), attributes (attribute)

author
OBJECT

Click to expand author

id
STRING

name
STING

email
STRING

phoneNumber
STRING

activity_logs (table), author (attribute)

conversationId
INTEGER

The conversation ID.

Reference:

conversations.id
activity_logs.conversationId

conversations

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	updated_at
Primary Key :	id	API endpoint :	Get conversations

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

conversations table schema

id
INTEGER

The conversation ID.

Reference:

conversations.id
activity_logs.conversationId

updated_at
INTEGER

The date the conversation was last updated. Measured in seconds since the Unix epoch.

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

Click to expand conversation_wrapup_notes

items
STRING

conversations (table), conversation_wrapup_notes (attribute)

created_at
INTEGER

custom_fields
ARRAY

Click to expand custom_fields

items
OBJECT

Click to expand items

archived
BOOLEAN

attribute_id
STRING

data_type
STRING

identifier
STRING

value
STRING

conversations (table), items (attribute)

conversations (table), custom_fields (attribute)

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

Click to expand ratings

items
OBJECT

Click to expand items

rating_language
STRING

rating_modified_timestamp
INTEGER

rating_scheduled_timestamp
INTEGER

rating_created_timestamp
INTEGER

rating_offered_timestamp
INTEGER

rating_status
STRING

rating_unscheduled_timestamp
STRING

rating_score
INTEGER

rating_rated_timestamp
INTEGER

rating_scheduled_for_timestamp
INTEGER

rating_cancelled_timestamp
STRING

rating_message
STRING

rating_type
STRING

conversations (table), items (attribute)

conversations (table), ratings (attribute)

requester_email
STRING

requester_id
STRING

requester_name
STRING

requester_phone_number
STRING

status
STRING

subject
STRING

tags
ARRAY

Click to expand tags

items
STRING

conversations (table), tags (attribute)

tags_info
ARRAY

Click to expand tags_info

items
OBJECT

Click to expand items

id
STRING

name
STRING

is_deactivated
BOOLEAN

conversations (table), items (attribute)

conversations (table), tags_info (attribute)

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_datestring
INTEGER

widget_id
STRING

widget_name
STRING

messages

View table schema on GitHub

Replication Method :	Key-based Incremental	Replication Key :	created_at
Primary Key :	id	API endpoint :	List messages

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

messages table schema

id
STRING

The message ID.

Reference:

messages.id
activity_logs.attributes.messageId

created_at
INTEGER

The date the message was created. Measured in seconds since the Unix epoch.

attached_files
ARRAY

Click to expand attached_files

items
STRING

messages (table), attached_files (attribute)

author_email
STRING

author_name
STRING

bcc
ARRAY

Click to expand bcc

items
STRING

messages (table), bcc (attribute)

cc
ARRAY

Click to expand cc

items
STRING

messages (table), cc (attribute)

chat_input_answer
STRING

chat_input_question
STRING

chat_menu_text
STRING

created_at_datestring
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

to
ARRAY

Click to expand to

items
STRING

messages (table), to (attribute)

to_phone_number
STRING

voicemail_url
STRING

Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.

Related	Troubleshooting
Destination & Integration Compatibility Replication Scheduling Syncing Historical SaaS Data Resetting Replication Keys Nested Data Structures & Row Count Impact	Third-Party Downtime Understanding & Reducing Your Usage Re-Authorizing Integrations Replication Issues