Connect Zendesk to B6AI
Set up the Zendesk integration end to end, from creating credentials in Zendesk to verifying the live connection and using it in your bots.
Overview
The Zendesk integration keeps your helpdesk as the system of record while B6AI handles the front line. When a bot can’t fully resolve an issue, it can open or update a Zendesk ticket and hand off with full context.
This means every escalation is captured, searchable and reportable in Zendesk, nothing falls through the cracks.
What you can do with Zendesk
Once connected, your bots and agents can use Zendesk inside conversations and automations. Typical uses include:
- Create a support ticket automatically when a bot escalates an issue.
- Add public replies or internal comments (including the conversation transcript) to existing tickets.
- Look up a ticket’s status by ID or by the customer’s email and report it back in chat.
- Set priority, tags and the target Zendesk group so tickets route correctly.
- Update ticket status (e.g. solved) when a conversation resolves.
How the integration works
B6AI calls the Zendesk REST API against your subdomain (yourco.zendesk.com). You can authenticate with an API token (Basic auth using an agent email plus the token) or with OAuth 2.0 for consented, revocable access.
Every call acts with the permissions of the agent the credentials belong to, so scope that agent’s role carefully. Credentials are stored encrypted at rest.
Prerequisites
Make sure all of the following are in place before you start. Each one is required, skipping any will cause the connection to fail later.
- A Zendesk Support account on a plan that includes API access.
- Administrator access to enable token access or create an OAuth client.
- Your Zendesk subdomain (the “yourco” in yourco.zendesk.com).
- An agent account with permission to create and update tickets (the API acts as this agent).
- The Enterprise Admin role in B6AI.
Create or prepare your Zendesk account
If your organization does not already use Zendesk, create an account first. Existing customers can skip to the next step.
- If you don’t have Zendesk, sign up at zendesk.com and complete onboarding.
- Note your subdomain from the URL you sign in at (https://<subdomain>.zendesk.com).
- Confirm your plan includes API access (most paid plans do).
Choose a connection method
B6AI supports more than one way to connect Zendesk. Pick the one that fits your organization’s policies, the rest of this guide works for either.
| Method | When to use it | Notes |
|---|---|---|
| API token (recommended) | A single Zendesk instance and the quickest setup | Uses an agent email + API token via Basic auth. Simple and stable. |
| OAuth 2.0 | You need revocable, per-user consent or stricter scoping | Create an OAuth client in Zendesk; B6AI runs the consent flow and stores an access token. |
Generate your Zendesk API token (or OAuth 2.0 credentials)
B6AI authenticates with Zendesk using your Zendesk API token (or OAuth 2.0 credentials). Follow these steps exactly, each field you copy here is entered into B6AI later.
- In Zendesk, open Admin Center (the gear icon) → Apps and integrations → APIs → Zendesk API.
- Turn Token access ON.
- Click Add API token, give it the description “B6AI”, then Copy the token now, Zendesk shows it only once.
- Note the email address of the agent/admin the API will act as.
- Note your subdomain from the sign-in URL.
Required permissions & scopes
Grant only the scopes below. Each one maps to a specific B6AI capability; requesting fewer reduces risk and speeds up any review your Zendesk administrator performs. The table explains exactly what each scope allows and why it is needed.
| Scope / permission | What it allows | Why B6AI needs it |
|---|---|---|
| Token access (enabled) | Allows API-token authentication | Required for the recommended API-token method |
| read (OAuth) / agent read permission | Read tickets, users and organizations | Look up ticket status and customer records |
| write (OAuth) / agent write permission | Create and update tickets and comments | Open and update tickets from bot conversations |
| tickets:read, tickets:write (OAuth) | Scope access to tickets only | Least-privilege option when using OAuth instead of a broad agent role |
Finish configuration inside Zendesk
Complete these steps in the Zendesk console before connecting B6AI, so the credentials are fully active.
- Keep Token access enabled while the integration is in use.
- Consider creating a dedicated agent (for example “B6AI Bot”) with a role limited to ticket create/update, and generate the token as that agent.
- If you chose OAuth, register the B6AI redirect URL in your Zendesk OAuth client.
Connect Zendesk in B6AI
Now enter your credentials in B6AI. Signed in as an Enterprise Admin, open Settings → Integrations, find the Zendesk card and click Connect, then complete the form. Every field is explained below.
- In B6AI, open Settings → Integrations → Zendesk.
- Choose API token or OAuth.
- Enter your subdomain, the agent email and the API token (or complete the OAuth consent).
- Optionally set a default group and priority for tickets B6AI creates.
- Click Save: B6AI runs a test read to validate access.
{
"provider": "zendesk",
"subdomain": "yourco",
"email": "support-bot@yourco.com",
"api_token": "…",
"default_group": "Tier 1 Support"
}| Field | What it is | Example value |
|---|---|---|
| Subdomain | Your Zendesk instance name | yourco (for yourco.zendesk.com) |
| Agent email | The agent the API acts as | support-bot@yourco.com |
| API token | The token you generated in Zendesk | gErT…9aB |
| Default group | Zendesk group new tickets route to | Tier 1 Support |
| Default priority | Priority applied to created tickets | Normal |
Verify the connection
Confirm the integration is live before you rely on it in a bot.
- Confirm the Zendesk card shows “Connected”.
- Run the built-in test: it creates a test ticket.
- Open Zendesk and confirm the test ticket exists with the expected group and priority.
- Delete the test ticket once you’ve confirmed it.
Troubleshooting
If the connection fails or an action does not work, match the symptom below to its cause and fix.
| Symptom / error | Likely cause | How to fix it |
|---|---|---|
| 401 Unauthorized | Token access is off, or wrong email/token | Enable Token access; re-copy the token; confirm the email is a real, active agent |
| 403 Forbidden | The agent lacks permission for that action | Give the API agent a role that can create/update tickets |
| 404 Not Found | Wrong subdomain | Enter only the subdomain, not the full URL |
| 422 Unprocessable Entity | A required ticket field is missing | Provide required fields (subject, requester) in the Action node |
Limitations & rate limits
Keep these constraints in mind so your bots behave predictably at scale.
- API rate limits vary by Zendesk plan, trial and lower tiers allow fewer requests per minute.
- Some ticket fields and features require specific Zendesk plans.
- API-token calls act with a single agent’s permissions, so scope that agent carefully.
Security best practices
- Grant only the scopes and permissions listed above, never request more “just in case”.
- Rotate your Zendesk API token (or OAuth 2.0 credentials) on a regular schedule, and immediately if you suspect exposure.
- Restrict the Enterprise Admin role (which manages integrations) to a small, trusted group.
- Prefer a dedicated service account or bot user over a personal login, so access survives staff changes.
- Review the integration’s activity in the B6AI Activity Logs periodically for unexpected calls.
- Disconnect the integration the moment a credential leaks; then rotate it in Zendesk before reconnecting.
Recommendations
- Test against a sandbox or non-production Zendesk account before connecting live data.
- Document which bots and flows depend on this integration so changes are predictable.
- Set a recurring reminder to review scopes and rotate credentials.
- Enable only the capabilities you actually use today; you can widen scopes later.