Zendesk OpenAPI
Posted Mar 28, 2021
Is there an Open API spec / Swagger file for Zendesk? I've seen a few threads from a while ago but wondered if there's any updates:
- https://develop.zendesk.com/hc/en-us/community/posts/360028870454/comments/360004529253
5
26
26 comments
Serge Pincon
Greg Katechis More than 2 years ago since you mentioned that we should "rapidly" get the Open API spec.. Any news and/or ETA?
It feels ever more awkward as it seems as if you are using GraphQL yourself for your clients...
1
Beto DJ
Greg , Greg, Greg .... so many promisses ... so many broken ...
1
Daniel Williams
Any updates on when this will be available?
1
Mitch Ryan
Nope, that won't do for our needs sorry Greg. That documentation is really no more useful than the written documentation provided here. It does not solve the needs of developers who need machine-readable definitions for request and response types, aka DTO (data transfer objects). In other words, we can't use this documentation to generate an SDK, because it doesn't document things as simple as what a "Ticket" object looks like*. There's a reason why people are asking specifically for OpenAPI definitions, because there's already a massive body of open-source tooling built upon it. Conversely, one of the reasons why there's not such a body of open-source tooling built upon Zendesk (such as a stable + actively maintained Node/Javascript/Typescript SDK) is because Zendesk does not publish its DTOs in a machine-readable format.
*I am aware that there are "example responses" for the "Show Ticket" request - but demonstrating an instance of a ticket response is not the same as the blueprint/schema of a ticket response. The latter would show *all* possible properties, which one of them are optional/nullable, what type (eg. `string`, `number` etc) they are.
5
Greg Katechis
Hi all! Could you take a look at the Postman collection that we have for our APIs and let me know if that will give you what you're looking for?
0
jon
+1. Any chance that work on this has been completed yet? This would definitely help us stay organized and create a clean API layer for Zendesk through our internal systems. Greg Katechis
1
Grant Rodger
Hi Greg Katechis,
Any news on when your API documentation will be available in the OpenAPI spec? Either publicly, or via a beta/early access programme?
Thanks,
Grant
0
Stewart Armbrecht
Any update? Is there any place we can go to get a partial file?
0
Mitch Ryan
Gidday Greg, what was that update?
0
Greg Katechis
Hi Paul, apologies for the delay on this one, it has been a lot of work getting all of our APIs up and running on this project. We have been working on making the OAS publicly available and I'm not sure what that timeline is looking like. I'm going to reach out to the team responsible for this today and when I hear back, I'll drop an update here for everyone!
1
Sign in to leave a comment.