Embedding the Zap Editor
By embedding our Zap Editor in your product, your users can create and edit their Zaps without leaving your product.
Creating a new Zap
Use the Partner API to query the public Zap templates featuring your integration (using the
GET /v1/zap-templates endpoint) and feature them in your product. When a user chooses a Zap template they’d like to try, use the
create_url value as the source to load in an embedded frame such as:
https://api.zapier.com/v1/embed/trello/create/113 is the
create_url value of the Zap template.
Optionally, you can add additional parameters to the
create_url to prefill the user’s Zap with custom values (e.g., specifying a workspace for the trigger to filter by).
Editing a Zap
Use the Partner API to load a user’s Zaps (using the
GET /v1/zaps endpoint). When the user chooses to open or edit a Zap use the the
url value of the Zap as the source of an embedded frame such as:
https://zapier.com/app/editor/123456 is the
url of the Zap to be edited.
Additionally, if you’d prefer, you can open these URLs in a separate window, new tab, or popup just as well.
Prefills allow you to define the fields on behalf of the user, thus simplying the experience of setting up their Zap.
You’ll use the
create_url (available in a Zap template object) in order to create the Zap. Next, you will add parameters to the
create_url so that the user’s Zap is prefilled with the provided custom values.
Note: You will need to know the fields that your app requires per step. You can find the fields as defined in your Zapier integration.
You can prefill the name of a Trello card (field:
name) in the second step of the Zap template:
Here’s what it would look like in the editor:
You can prefill multiple values for the user. In this example
desc are prefilled
You can provide a label for prefill dropdowns as we won’t fetch all of the pages of choices until the user opens the dropdown:
If you decide to embed the Zapier Editior within your product you can listen to message events from
postMessage which can help you improve the interactivity with the iframe (e.g. automatically close the iframe modal.)
The messages available include:
zap:unpause= Zap turned on / published
zap:unpause:done= Zap turned on / published (success)
zap:unpause:fail= Zap turned on / published (failure)
zap:pause= Zap turned off
zap:pause:done= Zap turned off (success)
zap:pause:fail= Zap turned off (failure)
Turning off a Zap
The API does not currently have an endpoint to turn off/on a user’s Zaps. If your Zapier app uses Webhook Subscriptions, you can send a
DELETE to the webhook subscription URL and that will then pause/turn off a Zap.