Prerequisites
- An active Zendesk Support account
- A Zendesk admin or agent user with API token access
- Admin access to both Zendesk and AGO
Step 1: Generate a Zendesk API Token
- Go to Zendesk Admin Center > Apps and integrations > APIs > Zendesk API
- Click the Settings tab
- Enable Token Access
- Click Add API token
- Copy the generated token — you will not be able to see it again
Step 2: Get Your Subdomain
Find your Zendesk subdomain in the URL:Step 3: Configure in AGO
- Navigate to Ticketing > Settings
- Set Active Ticketing System to Zendesk
- Enter your credentials:
- Admin Email: email address of the user who created the API token
- API Token: from Step 1
- Subdomain: from Step 2
- Click Save
Step 4: Create a Ticket Form
- Navigate to Ticketing > Ticket Forms
- Create a new form
- Add fields and configure custom field mapping to Zendesk
- Save the form
How It Works
When a user creates a ticket through AGO:- AGO validates the user (checks if they exist in Zendesk, or auto-creates if “Allow All Users” is enabled)
- Files are uploaded to Zendesk and receive upload tokens
- A ticket is created with subject, body, priority, type, custom fields, tags, group assignment, brand, and file tokens
- A private comment is added with a link to the AGO conversation thread (plus JWT fields and field values if configured)
- AGO triggers are processed, and the Zendesk support team is notified
Field Mapping
Custom Fields, Tags, and Group Assignment
Map AGO form fields to Zendesk custom fields usingexternal_id or zendesk_field_id (numeric, takes priority when set). Use tagger fields for user-selected tags, and static form tags for routing rules. Route tickets to groups at the form, field, or option level.
See Ticket Form Customization for full details.
Brand Support
For multi-brand Zendesk accounts, setbrand_id on a ticket form to create tickets under a specific brand.
Finding Brand IDs: Go to Zendesk Admin Center > Account > Brand management, click a brand, and find the ID in the URL.
Name Extraction
AGO extracts user names in this order:- Ticket fields marked with
use_to_set_first_name/use_to_set_last_name - First and last name from the AGO user profile
- Username part of the email address (before @)
User Permission Models
AGO supports two models for determining who can create Zendesk tickets.Model 1: Zendesk User Validation (Default)
Users must exist and be active in your Zendesk account. AGO searches for their email, and if found withactive: true and not suspended: true, caches their Zendesk user ID for 30 minutes.
Best for: Organizations with defined user lists in Zendesk.
Model 2: Allow All Users
Any AGO user can create tickets, even without a Zendesk account. Zendesk auto-creates a new user from the email address. Enable this via the “Allow All Users to Create Tickets” setting. Best for: Customer-facing widgets, public support portals. For widget users with auto-generated emails (likeunknown_ago@domain.com), AGO collects their real email during ticket creation and uses it for the Zendesk request.
Ticket Sync
AGO can sync ticket data from Zendesk back into the admin dashboard, keeping statuses, assignees, and comments up to date.What Gets Synced
Enabling Sync
- Navigate to your Zendesk ticketing system configuration in the admin interface
- Enable the Sync Enabled option
- Tickets sync automatically every hour
Manual Sync
- Tickets list page: Click Sync Tickets to sync all open tickets
- Ticket detail page: Click Sync Now to sync a single ticket immediately
Sync Behavior
- Only open tickets with an external ID are synced (closed tickets are skipped)
- Unchanged tickets are skipped for efficiency
- Zendesk agent comments appear with the agent’s name and an external system badge
- Private comments are imported as internal notes
- You can add internal notes from the AGO detail page (these stay in AGO only)
- AGO respects Zendesk API rate limits — large syncs may take several minutes
Troubleshooting
If issues persist, test with a simple ticket (no custom fields or attachments), then check AGO logs for detailed error messages.
For tips on field mapping, tag strategy, and routing, see Ticketing Best Practices.
Related
- Ticketing — Ticketing feature overview
- Ticket Form Customization — Form field configuration and embedded forms
- Ticketing Connectors — Compare available connectors
- HelpScout Integration — Alternative ticketing connector
- HubSpot Integration — Alternative ticketing connector
- Zendesk Knowledge Base — Knowledge base connector (separate from ticketing)
