Overview
The Zendesk Connector automatically syncs your support tickets, comments, and conversation history from Zendesk Support to cxconnect.ai.What Data is Synced
The connector will sync the following information from your Zendesk account:- Tickets: Customer support tickets including subject, description, status, and customer information
- Comments: All comments and internal notes on tickets
- Conversation Logs: Complete event history of ticket interactions and changes
Prerequisites
Before you begin, make sure you have:- Administrator access to your Zendesk account
- Your Zendesk subdomain (the first part of your Zendesk URL)
Required Information
You’ll need to provide the following when setting up the connector:| Field | What is it? | Where to find it |
|---|---|---|
| Your Zendesk account email | Your login email | |
| API Token | Secure access token | Generated in Step 1 below (save it immediately) |
| Subdomain | Your unique Zendesk identifier | First part of your URL (e.g., company from company.zendesk.com) |
Setup Instructions
Step 1: Generate API Token in Zendesk
- Log in to your Zendesk account as an administrator
- Click the Admin icon (gear icon) in the sidebar
- Go to Apps and integrations > APIs > Zendesk API
- Click the Settings tab
- Make sure Token Access is enabled
- Click Add API token
- Give it a description:
cxconnect.ai Sync - Click Save
- Important: Copy the API Token immediately - you won’t be able to see it again
Step 2: Find Your Subdomain
Look at your Zendesk URL to find your subdomain:- If your URL is
https://company.zendesk.com, your subdomain iscompany - If your URL is
https://acme-support.zendesk.com, your subdomain isacme-support
Step 3: Connect in cxconnect.ai Admin Portal
- Log in to the cxconnect.ai Admin Portal
- Go to Sync Connectors > Add Connector
- Select Zendesk
- Enter your information:
- Email: Your Zendesk account email
- API Token: Copy from Step 1
- Subdomain: From Step 2
- Click Test Connection to make sure everything is set up correctly
- Click Save & Activate to start syncing
Step 4: Monitor Your Sync
The Sync Engine is currently in development and not yet deployed. This documentation is provided in advance of the feature release.
- Initial sync may take some time depending on ticket volume
- Monitor progress in the Admin Portal dashboard
- Check sync logs for any issues
Troubleshooting
Connection Issues
Problem: Unable to connect or authenticate What to check:- Verify your email and API token are entered correctly
- Make sure Token Access is enabled in Zendesk API settings
- Check that the API token hasn’t been deleted or revoked
- Confirm your Zendesk account is active
- Verify the subdomain is spelled correctly
Wrong Subdomain
Problem: Connection fails with “not found” error What to check:- Make sure you’re using only the subdomain (e.g.,
company, notcompany.zendesk.com) - Double-check spelling of your subdomain
- Verify you’re using the correct Zendesk account
- Check if your account uses a different domain extension (e.g.,
.zendesk.co.uk)
Missing Comments
Problem: Tickets sync but comments are missing What to check:- Verify the API token has read permissions for comments
- Check that the tickets have comments in Zendesk
- Ensure internal notes are included if you want them synced
- Contact support if data consistently appears to be missing
Incomplete Data
Problem: Some tickets or conversation logs aren’t syncing What to check:- Verify the API token has full read permissions
- Check Zendesk for any archived tickets if needed
- Make sure custom fields are accessible
- Contact support if specific data types are missing
Need Help?
If you’re still experiencing issues:- Email Support: [email protected]
- Zendesk Documentation: Zendesk Developer Portal