Connecting Your Zendesk Instance¶

Configly uses OAuth 2.0 to securely connect to your Zendesk instance. This page explains how it works and how to set it up.

What is OAuth?¶

OAuth is a secure way to give Configly read-only access to your Zendesk configuration without sharing your password.

Think of it like giving someone a visitor badge to your building - they can look around, but they can't make changes or access restricted areas.

Connection Methods¶

Configly supports two authentication methods:

Method	Best For	Security
OAuth	Everyone (recommended)	Most secure, no passwords shared
API Token	Legacy integrations only	Requires storing credentials

We strongly recommend OAuth for all new connections.

Setting Up OAuth Connection¶

Step 1: Start the Connection¶

Log in to Configly at go.configly.app
Go to Connections
Click "Add Connection"
Enter your Zendesk subdomain (e.g., acme from acme.zendesk.com)
Give your connection a name (e.g., "Production" or "Acme Client")
Click "Connect via OAuth"

Step 2: Authorize on Zendesk¶

You'll be redirected to your Zendesk instance where you'll see a permission request screen.

What Configly Requests: - Read access to triggers, automations, macros, views, custom fields, and SLA policies - No write access - Configly cannot modify your Zendesk configuration

Click "Allow" to authorize Configly.

Step 3: Done!¶

You'll be redirected back to Configly with your connection established. You'll see a confirmation that your connection is active.

Now you can run your first sync →

What Happens Behind the Scenes?¶

You click "Connect via OAuth" - Configly generates a secure authorization request
Zendesk asks you to approve - You see exactly what permissions Configly needs
You approve - Zendesk sends Configly a secure access token
Configly stores the token - Encrypted in our database, never exposed
Token automatically refreshes - Before it expires, Configly gets a new one (no action needed)

Security & Privacy¶

Read-only access — Configly cannot modify your Zendesk data
Encrypted storage — all credentials are encrypted using AES-256-GCM
Automatic token refresh — access tokens are refreshed automatically before expiry
Revokable — you can disconnect at any time from Configly or Zendesk

Connection Status¶

Your connection status shows: - Active - Connected and working correctly - Token Expired - Automatic refresh in progress (usually resolves itself) - Error - Connection issue needs attention

If you see an error, click "Refresh Token" to manually refresh the OAuth token.

Troubleshooting¶

"Subdomain not found"¶

Your Zendesk subdomain is incorrect. Check the URL you use to access Zendesk (e.g., yourcompany.zendesk.com → use yourcompany).

"Authorization failed"¶

You cancelled the OAuth approval or there was an error. Try again, and make sure to click "Allow" when Zendesk asks for permission.

"Connection test failed"¶

Zendesk may be experiencing issues, or your account may lack the necessary permissions. Contact your Zendesk administrator.

See more troubleshooting →

Managing Connections¶

Editing a Connection¶

You can rename your connection at any time: 1. Go to Connections 2. Click the three dots menu 3. Select "Edit" 4. Update the name

Deleting a Connection¶

Deleting a connection will: - Remove all stored credentials - Delete all configuration snapshots for that connection - Cannot be undone

To delete: 1. Go to Connections 2. Click the three dots menu 3. Select "Delete" 4. Confirm deletion

Next Steps¶

Once connected, you're ready to run your first sync →