Zendesk
Version 0.0.1
Checkout the Zendesk API docs for more information
Set up
To set up with Zendesk, you just need your Zendesk Username, Password and Domain.
Your domain is your URL when you are accessing your Zendesk account e.g. https://<company_name>.zendesk.com.
For Zendesk - do not include the https:// or .zendesk.com
For Zendesk (Legacy) - please include https:// and .zendesk.com within the domain.
Alternatively, setup can also be done using a token (this is also our suggested method for set-up) by following these steps:
In the username field enter:
<email>/token
e.g. [email protected]/token
Note:
This is not the token value but the placeholder name "
token"
In the password field enter:
<token>
e.g. 7893u5gfd5g93tj349tu3489tuhu34ihtu3gt34
Note:
This is the token value - See how to get a Zendesk token here .
In the domain field enter:
<site>
e.g. mysupport (Do not include https:// or .zendesk.com)
It is recommended you use the Zendesk token as these do not expire but depending on your security level within Zendesk, your password will expire.
Features
| Feature | Support | Notes |
|---|---|---|
| Backfill | ✅ | Tickets, Ticket Comment, Users, Users Identities, Organisations, Ticket Metric Events (10 years). Ticket Fields, Groups (All time). Calls, Call Legs (5 years). |
| Incremental | ✅ | Tickets, Ticket Comment, Users, Users Identities, Organisations, Groups, Ticket Events, Ticket Metric Events, Calls |
| Custom backfill | ❌ | |
| API reliability | 🟢 | Reliable |
Reports detail
| ⬇️ Report | 🔑 Incremental key | 🔑 Primary key | 📄 Link to API endpoint |
|---|---|---|---|
| Tickets | GENERATED_TIMESTAMP | id | List all Tickets |
| Users | updated_at | id | List all Users |
| Organisations | updated_at | id | List all Organisations |
| Groups | N/A | id | List all Groups |
| Group Memberships | N/A | id | List all Group Memberships |
| Ticket Fields | N/A | id | List all Ticket Fields |
| Ticket Field Option (legacy only) | N/A | id | List all Ticket Field Options |
| Ticket Metric | N/A | id | Ticket Metrics |
| Ticket Metric Events | TIME | id | Ticket Metric Events |
| Calls | UPDATED_AT | id | Calls |
| Call Legs | UPDATED_AT | id | Call Legs |
| Ticket Comment | CREATED_AT | id | Ticket Comment Event |
| User Identities | UPDATED_AT | id | List Users Identities |
Limitations
Zendesk (Legacy) connector
We recently migrated from our Zendesk (Legacy) connector. All of the reports from the legacy are available on the new connecter other than Ticket Field Options as the Ticket Field Options are all returned with the Ticket Fields endpoint.
Authentication
Our suggestion is to use the
tokenoption for authenticating, as this is less prone to issues.
Backfill for
Ticket CommentA full backfill for this report may take over a day to complete.
Updated about 1 month ago