Partner API#

Introduction#

Zapier's Partner API is for approved partners that are seeking access to Zap templates that use their app. Results are in a raw JSON format that permits the partner to render the Zap template listing using their own tools and App Development guide, improving the user experience for the user.

EXAMPLE RESPONSE#
[{
  "description": "<p>Facebook Lead Ads are an excellent way to grow your list of individuals interested in learning more about your product or service, but taking a next step with those people can sometimes take a back seat to your other tasks. With this Facebook Lead Ads-MailChimp integration, you'll no longer need to think about adding new leads to a marketing campaign—each new lead is automatically added to the list of your choice.</p>\n\n<h2>How this Facebook Lead Ads-MailChimp integration works</h2>\n\n<ol>\n<li>Someone fills out one of your Facebook Lead Ads</li>\n<li>Zapier adds that individual to a specified list in MailChimp</li>\n</ol>\n\n<h2>Apps involved</h2>\n\n<ul>\n<li>Facebook Lead Ads</li>\n<li>MailChimp</li>\n</ul>\n",
  "title": "Subscribe new Facebook Lead Ad leads to a MailChimp list",
  "url": "https://zapier.com/zapbook/zaps/10127/subscribe-new-facebook-lead-ads-mailchimp-list/",
  "type": "guided_zap",
  "description_raw": "Facebook Lead Ads are an excellent way to grow your list of individuals interested in learning more about your product or service, but taking a next step with those people can sometimes take a back seat to your other tasks. With this Facebook Lead Ads-MailChimp integration, you'll no longer need to think about adding new leads to a marketing campaign—each new lead is automatically added to the list of your choice.\r\n\r\n## How this Facebook Lead Ads-MailChimp integration works\r\n\r\n1. Someone fills out one of your Facebook Lead Ads\r\n2. Zapier adds that individual to a specified list in MailChimp\r\n\r\n## Apps involved\r\n\r\n- Facebook Lead Ads\r\n- MailChimp",
  "slug": "subscribe-new-facebook-lead-ads-mailchimp-list",
  "description_plain": "Facebook Lead Ads are an excellent way to grow your list of individuals interested in learning more about your product or service, but taking a next step with those people can sometimes take a back seat to your other tasks. With this Facebook Lead Ads-MailChimp integration, you'll no longer need to think about adding new leads to a marketing campaign—each new lead is automatically added to the list of your choice.\n\nHow this Facebook Lead Ads-MailChimp integration works\n\nSomeone fills out one of your Facebook Lead Ads\n\nZapier adds that individual to a specified list in MailChimp\n\nApps involved\n\nFacebook Lead Ads\n\nMailChimp",
  "steps": [
    {
      "description": "Facebook lead ads make signing up for business information easy for people and more valuable for businesses. The Facebook lead ad app is useful for marketers who want to automate actions on their leads.",
      "title": "Facebook Lead Ads",
      "url": "https://zapier.com/zapbook/facebook-lead-ads/",
      "image": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.png",
      "api": "FacebookLeadsAPI",
      "slug": "facebook-lead-ads",
      "hex_color": "3b5998",
      "images": {
        "url_128x128": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.128x128.png",
        "url_64x64": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.64x64.png",
        "url_16x16": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.16x16.png",
        "url_32x32": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.32x32.png"
      },
      "id": 3535
    },
    {
      "description": "MailChimp is an email marketing service provider, founded in 2001. It has 6 million users that collectively send over 10 billion emails through the service each month.",
      "title": "MailChimp",
      "url": "https://zapier.com/zapbook/mailchimp/",
      "image": "https://cdn.zapier.com/storage/services/5c727288d9c2f69a9eee136c5f5a0f72.png",
      "api": "MailChimpAPI",
      "slug": "mailchimp",
      "hex_color": "239AB9",
      "images": {
        "url_128x128": "https://cdn.zapier.com/storage/services/5c727288d9c2f69a9eee136c5f5a0f72.128x128.png",
        "url_64x64": "https://cdn.zapier.com/storage/services/5c727288d9c2f69a9eee136c5f5a0f72.64x64.png",
        "url_16x16": "https://cdn.zapier.com/storage/services/5c727288d9c2f69a9eee136c5f5a0f72.16x16.png",
        "url_32x32": "https://cdn.zapier.com/storage/services/5c727288d9c2f69a9eee136c5f5a0f72.32x32.png"
      },
      "id": 6
    }
  ],
  "create_url": "https://zapier.com/partner/embed/facebook-lead-ads/create/10127",
  "id": 10127
}]
EXAMPLE LISTING (WIDGET.JS)#

Sign Up#

This API is currently for approved partners only. If you'd like to be considered for participating sign-up using this form.

Authentication#

Once approved, you will receive a secret API key. Do not share your secret API key. In the event that a key is compromised, you will need to notify us partner@zapier.com.

All API requests will need to include your secret API key.

Example Request#

curl https://zapier.com/partner/embed/zaps?key={secret}

Errors#

Zapier uses HTTP response codes to indicate the success or failure of an API request.

Code Status Explanation
200 OK Returns zero or more Zap templates in a JSON array.
400 Bad Request The request is missing or was provided invalid parameters.
401 Authentication The key you've provided is not valid.
5xx Server Error A fatal error occurred while processing the request. Try again.

All errors will be JSON object with a String array of errors:

{
  "errors": ["Malformed request"]
}

Zap templates Resource#

Returns a list of Zap templates.

Arguments#

All of the following arguments with exception to key follow widget.js arguments.

argument requirement notes
key Required This is your API key. Do not share.
templates Optional A comma separated list of specific Zap templates (guided zaps).
apps Optional A comma separated list of Zapier Apps to match Zap templates against. Note: Your app will be one of the apps.
limit Optional (defaults to 5, max of 100) Limit the number of Zap templates returned.

Example Requests#

Get all Zap templates for my app.

curl -L http://zapier.com/partner/embed/zaps?key=${secret}

Get specific Zap templates for my app.

curl -L http://zapier.com/partner/embed/zaps?key=${secret}&templates=1014234,2341134

Get all Zap templates that include my app and another.

curl -L http://zapier.com/partner/embed/zaps?key=${secret}&apps=mailchimp

The Zap Template Object#

attribute type notes
create_url String An absolute URL used to create the Zap.
description String The HTML-rendered description provided when the Zap template was created.
description_plain String Plain text (HTML tags stripped) description. Note: \r and \n replaced with space character. Artifacts may be present.
description_raw String The Markdown description provided when the Zap template was created.
slug String A URL/SEO friendly ID for the Zap template.
steps Array An array of two or more steps in the Zap template. See below.
title String The name of the Zap template.
url String An absolute url to the Zapbook Zap template Page.
{
  "create_url": "https://zapier.com/partner/embed/facebook-lead-ads/create/10127",
  "description": "<p>Facebook Lead Ads are an...",
  "description_plain": "Facebook Lead Ads ... ",
  "description_raw": "**Facebook Lead Ads** are an ...",
  "slug": "subscribe-new-facebook-lead-ads-mailchimp-list",
  "steps": [{"... see App Object below ..."}],
  "title": "Subscribe new Facebook Lead Ad leads to a MailChimp list",
  "url": "https://zapier.com/zapbook/zaps/12084/subscribe-new-facebook-lead-ads-mailchimp-list/"
}

create_url and Prefill Options#

Always link the user with the create_url in order to create the Zap. Optionally, you can add additional parameters to the create_url so that the user's Zap is prefilled with the provided custom values. You will need to know the fields that your app requires per step.

One tip is to use the Zap template editor to find these fields.

Each parameter is in a flattened dictionary/object syntax. For example an object: {a: {b: 2}} would be flattened to: a__b=2. This allows you to provide countless prefills onbehalf of the user.

Example#

Prefill Trello's board ID (field: board) in the second step of the Zap template:

https://zapier.com/app/editor/template/2405?steps__1__params__board=12345

Here's what it would look like in the editor:

If you'd like to provide a label for the value (e.g. a Board's name) you can do so by passing an additional parameter:

https://zapier.com/app/editor/template/2405?steps__1__params__board=12345&steps__1__meta__parammap__board=My+Board

The App Object#

attribute type notes
description String Plain text description of the app.
hex_color String A Web Color Hex. Useful for icon/display background.
image String The app's logo in large format.
images Object Thumbnails for the app image.

Available sizes (and respective keys): url_128x128, url_64x64, url_32x32, and url_16x16. slug | String | A URL/SEO friendly ID for the app. title | String | The name of the app. url | String | An absolute url to the Zapbook Apps page.

{
  "description": "Facebook lead ads make signing up for business information ...",
  "hex_color": "3b5998",
  "image": "https://cdn.zapier.com/storage/s/fd9fef95169fd589d6cda992c0057cf8.png",
  "images": {
    "url_128x128": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.128x128.png",
    "url_16x16": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.16x16.png",
    "url_32x32": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.32x32.png",
    "url_64x64": "https://cdn.zapier.com/storage/services/fd9fef95169fd589d6cda992c0057cf8.64x64.png"
  },
  "slug": "facebook-lead-ads",
  "title": "Facebook Lead Ads",
  "url": "https://zapier.com/zapbook/facebook-lead-ads/"
}
↑ Was this documentation useful? Yes No
Get Help