Leveraging the Power of Zapier's Partner API and Embedded Editor

  • 15 June 2023
  • 0 replies

Userlevel 2

Hey Zapier Developers,

I'm a product manager here at Zapier, and I can't wait to share some fantastic tools that can boost the usage of your Zapier integration, leading to even more activity in your own app. Our Partner API and Embedded Editor are designed with just this in mind - to give you more control, flexibility, and ultimately, drive more engagement. These tools are going to help you create top-notch, user-friendly automation experiences right within your product. It's all about helping you crank up that user engagement! So, get ready to take things to a whole new level!

What is the Partner API?

The Partner API is a tool that allows you to customize how you present Zapier within your product, without sacrificing your integration’s look, feel, and flow. It's like a native Zapier integration that helps you showcase your best Zapier-powered workflows where it’s most helpful to your users.

With the Partner API, you can:

  • Get a list of all the apps available in Zapier’s app directory.
  • Have complete style control over how you present Zap templates in your product.
  • Get access to all your Zap templates and give your users the ability to search to quickly find the one they need.
  • Streamline Zap setup by pre-filling fields on behalf of your users.
  • Show users the Zaps they have set up from right within your product.
  • Embed our Zap Editor to allow your users to create new Zaps and modify existing ones, without needing to leave your product.

So What’s New?

Partner API Updates

We’ve made some exciting updates to the Partner API over the last month that include:

  • Enhanced App Search: We've added new query parameters to the /v1/apps endpoint. You can now use title_search, title_starts_with, category, and is_in_zap_template_with to refine your app search results. This means you can now search for apps based on their title, category, or whether they appear in a specific Zap template. This will make it easier for you to find the apps you need and create more powerful and tailored Zaps.
  • Zap Parameters: We've also added a new query parameter to the /v1/zaps endpoint. By using get_params, you can now retrieve Zaps along with their associated key/value param settings. This will give you more control and flexibility when managing your Zaps.
  • New Categories Endpoint: Last but not least, we've introduced a new endpoint: /v1/categories. This endpoint returns a list of all supported Zap categories, allowing you to explore and understand the different categories of Zaps available.

For a more in-depth understanding, refer to our detailed API documentation.

New Prefill Generator

The Pre-filled Zap Generator is a user-friendly tool that allows you to construct pre-filled Zaps. These are simply URLs with field values added as parameters, which direct users to the Zap Editor with some input fields already filled out. By placing these URLs inside your product within an embedded Zap Editor, you can simplify the automation discovery and creation experience for your users.

How to Use the Pre-filled Zap Generator?

You can find the Pre-filled Zap Generator under the "Pre-filled Zaps" section of the developer platform. Here's how to use it:

  1. Select an App and Event: Choose an app and event for both the trigger and action. This will display the fields you can pre-fill. If no fields appear, the event has no input fields.
  2. Select the Fields to Pre-fill: Choose the fields you want to pre-fill. If you don't want to pre-fill a field, leave the box unchecked. If there's a static value for a field that applies to every user's Zap (like the title of an email), check the field and provide the value in the text field. If the values are dynamic or unknown (like an account or list ID field), replace the placeholders represented in curly brackets (i.e {TRIGGER_LIST_ID}) in the generated URL.
  3. Test the Zap: We provide a handy test button for you to make sure the resulting Zap is what you intended. You'll need to connect accounts on both steps to see the pre-filled fields.
  4. Embed the Code: Copy the code and embed it inside your app to make setting up a Zap easier and faster for users.

Please note, the generator currently only supports creating 2-step Zaps, but you can construct multi-step Zaps by building upon the generated URL and adding steps parameters with increased indices.

Final Thoughts

The Partner API, along with the capabilities of Prefills and our Embedded Editor, are potent resources designed to enhance the automation experience within your own product. By effectively utilizing these tools, you can deliver a seamless and intuitive user experience. This approach allows your users to remain within your product environment, thereby minimizing context switching and enhancing their overall productivity and satisfaction.

If you have any questions or need further assistance, don't hesitate to reach out. We're here to help you make the most of your Zapier embedded Experience.


Ryan Powell

Product Manager at Zapier


0 replies

Be the first to reply!