Zendesk
For a school moving its desk from Zendesk to Plugboard. While the connector is on, a repair lodged in Plugboard raises its ticket in Zendesk as well, and the Plugboard ticket keeps the link to it; Plugboard can read a linked ticket’s status, add notes to it and close it; and the desk’s search can find the tickets still in Zendesk. Once the open work is across, turn the connector off.
| Category | Ticketing |
| Authentication | API token |
| Reaches | https://yourorg.zendesk.com |
| Needs an agent | No |
| Demo mode | No |
Capabilities
Section titled “Capabilities”ticket.create, ticket.get, ticket.syncStatus, ticket.comment,
ticket.close, ticket.search
It is checked against recorded Zendesk responses, not against a school’s own Zendesk account. Run Save and test and one test repair against yours before the switch depends on it.
Getting the credentials
Section titled “Getting the credentials”- In Zendesk, go to Admin Center, Apps and integrations, Zendesk API.
- Enable Token access if it is not already on.
- Add API token, describe it as
Plugboard, and copy the token. It is shown once. - Note the email address of the agent whose account the token belongs to.
The token authenticates as that agent, so tickets created by Plugboard are attributed to them. Use a dedicated integration agent account rather than a person, so the attribution stays meaningful and does not stop working when they leave.
Configuring it in Plugboard
Section titled “Configuring it in Plugboard”Settings, Connectors, then Zendesk under Add a service, and Continue to setup.
Settings
Section titled “Settings”| Field | Value |
|---|---|
baseUrl | Your Zendesk URL, for example https://yourorg.zendesk.com |
email | The agent email the token belongs to |
federatedSearch | Optional. Includes Zendesk results in the desk’s search, run as this agent |
Credentials
Section titled “Credentials”| Field | Value |
|---|---|
apiToken | The API token from step 3 |
Save and test.
Moving across from Zendesk
Section titled “Moving across from Zendesk”Give the switch a cutover date and keep the overlap short, because work that sits in two queues gets done in neither.
- Before cutover, connect Zendesk. Repairs raised in Plugboard then appear in Zendesk too, so the old desk stays complete while people still look there. Turn on federated search in the connector’s settings if the desk should find tickets still in Zendesk; see your external helpdesk for what that trades.
- Carry the open tickets across by hand: raise each in Plugboard and close it in Zendesk with a note naming the new ticket. It is usually a few dozen. Closed tickets stay in Zendesk; see historical tickets do not migrate.
- On cutover day, new requests go to Plugboard and you turn the connector off, so repairs raise their tickets in Plugboard alone. Keep Zendesk readable for as long as people need its history.
Status mapping
Section titled “Status mapping”While the connector is on, each Plugboard status can carry an external status it maps to, set on the workflow page, so a status change here is reflected in Zendesk. Zendesk’s statuses are new, open, pending, hold, solved and closed.
A reasonable mapping:
| Plugboard | Zendesk |
|---|---|
| Received | new |
| In progress | open |
| Awaiting parts | hold |
| With vendor | pending |
| Ready | pending |
| Closed | solved |
Solved rather than closed for the last one, because Zendesk closes solved tickets itself after its own interval, and closing outright prevents a follow-up comment.
Troubleshooting
Section titled “Troubleshooting”| Symptom | Cause |
|---|---|
401 on test | Token access is disabled, the token is wrong, or the email does not match the token’s owner |
403 | The agent lacks permission for that operation, usually on a restricted brand or group |
404 on ticket operations | The ticket was deleted in Zendesk, or the base URL points at the wrong subdomain |
| Tickets created but not updated | The status mapping is empty, so nothing is being pushed |
| Duplicate tickets | The same request was raised in both desks. Raise new work in Plugboard only |
Related
Section titled “Related”- Moving in, for what else comes across.
- The ticket queue, where the work lands.
- Web Help Desk, for a school moving from that.