Prerequisites
- Your app needs to be published as a public integration in Zapier’s App Directory.
Example implementation
Unbounce uses the /zaps endpoint to display users' Zap workflows using their integration directly within the Unbounce platform.
Fetching a list of Zap workflows for a user
1
Authenticate with Zapier
Following the authentication
guide, receive
a token from the Zapier Workflow API.
2
Create your request, and filter as needed
Leverage the
/zaps
endpoint to fetch a
users Zap workflows. - You can optionally filter the list by specific input
values, which can be helpful for instances where a user has a Zap associated
to specific resources. Example might be a specific trello board or google
sheet. See the
api-reference for more
info. - Leverage the expand parameter to return additional Zap detail such
as step information. - Use the zap:all scope to return all the owned Zap
workflows on a user’s acccount, regardless of paired apps. - Use the
include_shared=true query parameter to return all the owned and visible
Zap workflows on a user’s account. (This requires the zap:account:all
scope which otherwise behaves as zap:all). By default, only Zap workflows that contain the authenticating app and
that are owned by the user are returned. Use of the
zap:account:all
scope is required to access shared Zap workflows or workflows the user may
have permission to view/edit. The scope also controls the
inputs field on each step. With the zap
scope, inputs is null for steps that do not use your integration. With
zap:all or zap:account:all, inputs is returned for every step. Check
the OAuth scopes
reference
for details.3
Integrate with your product
Shape the workflows returned to match the look and feel of your product,
showcasing any existing workflows.