Exploring Zendesk APIs with Postman

Have more questions? Submit a request

9 Comments

  • Amie B
    Comment actions Permalink

    Since you've deactivated the developer console portal over the weekend, without any prior warning, I'm now forced to use postman. Something which I know nothing about. Whilst postman is a 3rd party tool, it would be nice if you could have a proper article on how newbies like myself can actually run a query via Postman. 

    The above article gets me halfway set up but now I'm stuck and have no idea what to do or how to get my API call to run via postman. 

    0
  • Greg - Community Manager
    Comment actions Permalink

    Hey Amie B! Thanks for bringing this up! I was going to write something up about this very topic and I'd love to discuss with you some of the specific issues that you're running into so that I make sure I'm covering as much as is needed. Would you mind sharing a screenshot of the part where you're stuck in Postman and then I'll be able to give you an idea of where we'd need to go next. If you could also let me know any other difficulties that you're running into, I'm happy to help sort those out, as well as incorporate them into an article.

    Also, in case this is helpful, Postman's documentation in this area is actually super robust and helpful: https://learning.postman.com/docs/postman/launching-postman/sending-the-first-request/

    2
  • Charles Nadeau
    Comment actions Permalink

    Hi Amie,

    We added a quickstart section to the article:

    Quickstart - Making a Zendesk API request

    Let us know if it helps.

    Charles

     

    1
  • Amie B
    Comment actions Permalink

    Hey team,

    I really appreciate the quick turnaround from you both with help and the update to this article with more details. It's def helped me and have been able to successfully run some ZD API calls via postman now. Feeling much more confident now. :)

    The bit I was getting stuck with was - I had this (see below) and I couldn't figure out where to input it in Postman to run it against the API call. I managed to figure it out that it needed to go in the Body tab, as RAW and Set to JSON. Once I did that it executed as I expected from there. 

    {
    "ticket": {
    "status": "open"
    }
    }
     
    It might be worth updating the above, on how to run the API call with a script like the example I was using, as well as showing the community how to set it up via a parameter. 
     
    Have a great day! 
    1
  • Charles Nadeau
    Comment actions Permalink

    Good point. I added a description of how to include request data in step 4 of the quickstart section.

    Thanks.

    0
  • Enes Dogan
    Comment actions Permalink

    Hi Darren Chan, nice introduction. Maybe i missed it but i could not find.

    Why don't you provide a Postman collection for your APIs? I find this kind of solution with Sunshine API at https://developer.zendesk.com/rest_api/docs/sunshine/custom_objects_api#run-in-postman.

    That makes life easy while working Zendesk. I am struggling while working Support API.

    Thanks for your help.

     

    2
  • Bryan - Community Manager
    Comment actions Permalink

    Hi Enes Dogan — thank you for the feedback and pointing out the need for more Postman collections. It's definitely a valid point and has been requested before.

    I can't say when exactly, but improvements to this area and better integration with development tools such as Postman is planned, so we're definitely on the same page!

    2
  • Dave Kaminsky
    Comment actions Permalink

    Darren Chan & Bryan - Community Manager,

     

    This is a an example of using Postman as a Zendesk Extension for use as a Target in a. Automation or Trigger?  This would help those of us who are switching to or following API Led design principals but are just starting with postman.  

    0
  • Greg - Community Manager
    Comment actions Permalink

    Hi Dave Kaminsky! Could you explain specifically what you're looking for with this request? I'd be happy to provide a more concrete example for your use-case!

    0

Please sign in to leave a comment.

Powered by Zendesk