Connect Zendesk
Keel reads the status of the Zendesk tickets linked to a person’s onboarding or offboarding once a day. The status shows in the Tickets panel on the person’s page, and the Leaver tickets resolved within 7 days check looks at every offboarding ticket. Linking tickets is described in Onboarding records.
Zendesk API tokens carry the permissions of the agent who uses them. Keel sends only read requests, only to the subdomain you connect, and stores the token encrypted.
Time: about 5 minutes.
Before you start
Section titled “Before you start”- In Zendesk: you are a Zendesk admin, so you can create API tokens, and you know an agent who can view the tickets your onboarding and offboarding work uses.
- In Keel: you are an owner or admin of the workspace.
Create the API token
Section titled “Create the API token”- In Zendesk, open Admin Center.
- Go to Apps and integrations > APIs > API tokens.
- Click Add API token. Description:
keel-evidence. - Copy the token, then click Save. Zendesk shows it only once.
Connect it in Keel
Section titled “Connect it in Keel”- In Keel, open Integrations, find the Zendesk card and click Connect.
- Under Credentials, fill in:
- Subdomain: the first part of your Zendesk address,
acmeforacme.zendesk.com. - Agent email: the agent Keel reads tickets as.
- API token: the token you copied.
- Subdomain: the first part of your Zendesk address,
- Click Save connection.
Evidence connector connected. Its credential is stored encrypted. means it worked.
See the first findings
Section titled “See the first findings”Open the Findings tab and click Collect now, or wait for the next daily run.
- An offboarding ticket passes when it was solved within 7 days of its creation, or when it is still open and inside those 7 days. Keel reads the solve time from the ticket’s metrics.
- It fails when it was solved later, or is still open after 7 days.
- A ticket on a different subdomain than the one connected is listed as unreadable. Keel never sends the token anywhere else.
To leave a person out of the check, put them out of scope from Affected items.
Troubleshooting
Section titled “Troubleshooting”| What you see | What to do |
|---|---|
| Check the connection details and try again. | The subdomain, email or token is wrong, or token access is off in API tokens. Check each and connect again. |
| A ticket shows Could not read the ticket (HTTP 403) | The agent cannot view that ticket. Use an agent who can. |
Rotate or remove access
Section titled “Rotate or remove access”- Rotate: add a new token, disconnect and reconnect in Keel, then delete the old token under API tokens.
- Remove: click Disconnect in Keel, then delete the token.