Skip to main content

Get Support
Have a question? Let's get you an answer!

How Do I...? Troubleshooting Code & Webhooks Developer Zone

Other Help Resources
Wait, there's more! Check out these Community sourced spaces for additional resources.

Zapier Help Center Hire an Expert

Learning Resources
All of our best learning resources can be found here.

Featured Articles Show & Tell Zapier's products AI Hub Zapier Tools Hub

Share your knowledge
Give back to the Community by sharing your automation wins and helping to answer questions.

Share your success See unanswered questions User Groups

Other Learning Resources
Some of our favorite additional ways to upskill your Zapier knowledge.

Zapier Learn Zapier Blog Zapier Webinars

Product Updates
Check out what is new and upcoming with Zapier with our regular product updates.

Product Updates

Early Access Program
Want to join Early Access? Learn more here.

Question

How do you define "API Documentation"

  • December 14, 2020
  • 5 replies
  • 1110 views
pdog
  • pdogBeginner
  • Beginner
  • 9 replies

We are trying to publish our integration but one field is “API Documentation URL”. When we try to understand what you mean by this, we click on the guidelines here:

https://platform.zapier.com/partners/document-support

 

And this says “Coming Soon”… 

 

We are being asked to provide a document but it’s not documented what Zapier wants.

 

So is this meant to be a technical document or more user friendly guide on how to use our integration to make a zap. For example is it something like what LeadPages has done here: https://support.leadpages.com/hc/en-us/articles/360002382371-Integrate-Zapier-With-Leadpages ???

 

Some examples would be appreciated as I can’t tell what you really want. Also, where is this URL listed for each integration? I can’t find it for the example above - had to find it with a Google search… 

 

Thanks,

Peter

    Did this topic help you find an answer to your question?
    This post has been closed for comments. Please create a new post if you need help or have a question about this topic.

    5 replies

    Troy Tessalone
    Forum|alt.badge.img+14
    • Troy TessaloneZapier Expert
    • Zapier Expert
    • 30939 replies
    • December 14, 2020

    Examples

    1. Mailchimp API Reference: https://mailchimp.com/developer/api/
    2. Pipedrive API Reference: https://developers.pipedrive.com/docs/api/v1/
    ⚡ Troy Tessalone - AutomationAce.com | Premier Certified Zapier Expert | #1 Zapier Community Contributor
    pdog
    • pdogBeginner
    • Author
    • Beginner
    • 9 replies
    • December 14, 2020

    Thanks Troy… but… this has me more confused.

     

    The above examples are for overall API’s. 

     

    Our software doesn’t have a published API but we want to pubish our integration with Zapier. Still not sure what they are asking for.

    Z
    Forum|alt.badge.img+9
    • ZaneZapier Staff
    • Zapier Staff
    • 331 replies
    • December 14, 2020

     

    The purpose of that doc link is for the Zapier support team, in the future, as they research and troubleshooting bugs, triaging issues, and helping our mutual customers.  So I’d add whatever you feel is the most helpful toward that end.  It won’t be a link that makes it into the customer-facing experience.  

     

    Thanks for pointing out the gap in the docs.

     

     

    pdog
    • pdogBeginner
    • Author
    • Beginner
    • 9 replies
    • December 14, 2020
    Zane wrote:

     

    The purpose of that doc link is for the Zapier support team, in the future, as they research and troubleshooting bugs, triaging issues, and helping our mutual customers.  So I’d add whatever you feel is the most helpful toward that end.  It won’t be a link that makes it into the customer-facing experience.  

     

    Thanks for pointing out the gap in the docs.

     

     

    Hi Zane - ok so if we don’t have a published API, what do we submit? Link to a page that says we don’t have an API and to use Zapier? That’s the plan I guess.

    AndrewJDavison_Luhhu
    Forum|alt.badge.img+10

    @pdog 

    An API is how Zapier connects to your app. So if you don’t have an API, this is all moot.

    If you mean you have an API, but it’s not publically documented, I think you'll need it to be. I believe Zapier asks for this URL so they can look at the docs when they are doing QA on your integration.

    We're Zapier Certified Experts - we help businesses do cool stuff with automation | www.luhhu.com
    Terms & Conditions