Skip to content
This repository was archived by the owner on Nov 29, 2024. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
3c2dfca
Updated URL to fix typo
megan-driscoll Mar 19, 2021
d78f613
Update docs/_partner_api/embedding.md
megan-driscoll Mar 19, 2021
2981720
Merge pull request #191 from zapier/megan-driscoll-patch-1
megan-driscoll Mar 19, 2021
9da3ecf
Fix typo in resthook documentation
skylerwshaw Mar 20, 2021
9348cc1
Merge pull request #192 from zapier/PDE-2121
skylerwshaw Mar 22, 2021
2c151cb
transfer update from z/z version to docs
armchairlinguist Mar 30, 2021
44769ed
bump conversion release date
xavdid Apr 5, 2021
c152824
Merge pull request #196 from zapier/sample-example
armchairlinguist Apr 5, 2021
1d77c73
Update integration-checks-reference.md
iscorer Apr 6, 2021
8cac6b0
Update footer for help docs to point to Partner contact form in the d…
nickm0501 Apr 6, 2021
7926272
Delete CNAME
leonsodhi-lf Apr 7, 2021
b338f72
Create CNAME
leonsodhi-lf Apr 7, 2021
01dabb3
Merge pull request #197 from zapier/PDE-2168
xavdid Apr 8, 2021
627a74b
Merge pull request #199 from zapier/SUPPORTOOL-299-platform-docs
nickm0501 Apr 15, 2021
74f6715
add clarity in the VB docs about deprecation consequences
armchairlinguist Apr 20, 2021
4d93b12
Add a note about being careful with deprecation
armchairlinguist Apr 21, 2021
9c7ee96
Merge pull request #200 from zapier/clarify-deprecation-vb
armchairlinguist Apr 21, 2021
3292446
Use copy suggested on PR review
iscorer Apr 27, 2021
1eb0167
Correctly format performList method name
iscorer Apr 28, 2021
ef54cd6
Merge pull request #198 from zapier/update-d006-intro-para
iscorer Apr 29, 2021
e25990a
Update zap-templates.md
jjproenca May 10, 2021
4879f90
Update zap-templates.md
jjproenca May 10, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _layouts/post-toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ <h3>Contents</h3>
<section class="content">{{ content }}</section>
<footer class="prev-next">{% include prev-next.html %}</footer>
<hr>
<p><em>Have any feedback or questions? <a href="https://github.com/zapier/visual-builder/issues/new/choose" target="_blank">Let us know</a>.</em></p>
<p><em>Need help? <a href="https://developer.zapier.com/contact" target="_blank">Tell us about your problem</a> and we’ll connect you with the right resource or contact support.</em></p>
</main>
{% include javascript.html %}
</body>
Expand Down
2 changes: 1 addition & 1 deletion _layouts/post.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<footer class="prev-next">
{% include prev-next.html %}
<hr>
<p><em>Have any feedback or questions? <a href="https://github.com/zapier/visual-builder/issues/new/choose" target="_blank">Let us know</a>.</em></p>
<p><em>Need help? <a href="https://developer.zapier.com/contact" target="_blank">Tell us about your problem</a> and we’ll connect you with the right resource or contact support.</em></p>
</footer>
</div>
</main>
Expand Down
2 changes: 1 addition & 1 deletion docs/_cli_tutorials/resthooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ which is then called in the `performSubscribe` method on the module for the Trig
```
module.exports = {
// Other data about the Trigger, e.g. key, name, etc. omitted
performSubscribe: performSubscribe
performSubscribe: subscribeHook
};
```

Expand Down
9 changes: 4 additions & 5 deletions docs/_conversion/maintaining.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ _To make a change to your integration._

- Create a new version by cloning an existing version in the versions section found in the left-hand navigation bar.
- Make your changes to the new version.
- If you have invited testers they can create Zaps with this new version before anyone else has access to it.
- If you have invited testers, they can create Zaps with this new version before anyone else has access to it.
- When you’re ready for the world to use your new version, promote it. Promoting a version makes it the version new users will see when they make Zaps.
- If you didn’t make breaking changes, migrate your users to the new version. Unlike Web Builder, this doesn’t happen automatically. You can control when it happens. A useful practice, when introducing non-trivial changes, is to migrate percentages of your users and watch for problems in your logs before migrating 100%.
- If you made breaking changes, you can simply leave users using the older version, or deprecate the old version to force users to reconfigure their Zaps to accommodate your changes.
Expand All @@ -45,12 +45,11 @@ A breaking change happens when you need to change something that prevents us fro
- Removing a trigger/action/search
- Changing the key of a trigger/search/action or any inputField


## Deprecation

Deprecation is an extremely useful feature introduced in the new platform. If you made a breaking change and can’t migrate users to your new version, you might choose, if necessary, to deprecate the older version. This will automatically email users of the older version to let them know they need to revisit the Zap Editor and reconfigure their Zaps for your newer version. On the deprecation date you set any remaining Zaps still using the deprecated version will be paused. Zapier is a "set it and forget it" experience for users, so use this feature carefully weighing the impact to user experience.
Deprecation is an extremely useful feature introduced in the new platform. If you made a breaking change and can’t migrate users to your new version, you can choose, if necessary, to deprecate the older version. This will automatically email users of the older version to let them know they need to revisit the Zap Editor and reconfigure their Zaps for your newer version. On the deprecation date you set, any remaining Zaps still using the deprecated version will be paused. Zapier is a "set it and forget it" experience for users, so use this feature carefully weighing the impact to user experience.

> **To minimize user disruption, try to avoid too frequent breaking changes and deprecations.**
> **To minimize user disruption, try to avoid frequent breaking changes and deprecations.**

![](https://cdn.zappy.app/567798b6c42e238d9d446763d5d9abbc.png)

Expand All @@ -60,7 +59,7 @@ Deprecation is an extremely useful feature introduced in the new platform. If y

## Teams

This is not _new_ functionality, unique to the new platform, but as a reminder be sure to add your whole team as admins to collaborate on the development and maintenance of your integration. There's no need to share logins. It's helpful that each member of your team is added, so everyone can see the status of the integration and get notification emails when a user reports a bug or feature request for your integration through Zapier support.
This is not _new_ functionality, but as a reminder, be sure to add your whole team as admins to collaborate on the development and maintenance of your integration. There's no need to share logins. It's helpful that each member of your team is added, so everyone can see the status of the integration and get notification emails when a user reports a bug or feature request for your integration through Zapier support.

In addition to "Admins" who can change and manage your integration, you can also add "subscribers". Those folks will get emails about the integration's performance, but won't be allowed to edit the integration.

Expand Down
9 changes: 4 additions & 5 deletions docs/_conversion/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,20 @@ layout: post-toc
redirect_from: /conversion/
---


# Update Your Web Builder Integration To Run On The Current Platform

## Overview

In 2017 Zapier released a major update to our platform, which includes access to better analytics, versioning, migration, deprecation facilities, and more. Integrations created with the original Web Builder tool need to be adapted to run on the new platform. Then your users’ Zaps must be updated with the new version of your integration.

We created a self-service conversion tool to recreate Legacy Web Builder integrations on the new platform, and update your users’ Zaps. You won’t need to write any code or require action from your users.
We created a self-service conversion tool to recreate Legacy Web Builder integrations on the new platform, and update your users’ Zaps. You won’t need to write any code or require action from your users.

The tool will guide you through a three step process:

1. Create a copy of your integration updated for the new platform.
1. Test your integration’s triggers and actions on the new platform.
1. Update your existing users’ Zaps to use the new integration.
1. Test your integration’s triggers and actions on the new platform.
1. Update your existing users’ Zaps to use the new integration.

The legacy platform will be disabled this year, so this process is required to maintain your integration. We’ve worked hard to make this process as easy as possible while avoiding any impact on users.

>**This feature is being progressively rolled out, and may not be immediately available for your integration. It is planned to be available to everyone by the end of March 2021.**
> **This feature is being progressively rolled out, and may not be immediately available for your integration. It is planned to be available to most developers by the end of April 2021.**
25 changes: 15 additions & 10 deletions docs/_docs/integration-checks-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,10 +181,12 @@ if the trigger key you specify doesn't exist.

When users are setting up a hook-based (aka instant) Trigger, it's important to have
a polling fallback. For example, imagine a Zap that triggers on a new Slack message.
Without a polling URL, the test won't complete without the user sending an actual
message in a Slack channel, which is disruptive. Instead, the test fetches a (real)
recent message and uses it as the test result. After that, the polling URL is only
used for tests.
If testing relies on the sending of a webhook, the test won't complete without the user
sending an actual message in a Slack channel, which is disruptive.

Instead, during testing, the Perform List (`performList`) operation fetches a
(real) recent message using the provided URL for polling and uses it as the test result.
The polling URL is only used for tests.

It's very important that the structure of an object from a webhook and from a poll
are identical. Typically, this means modifying a poll result so that it looks like a
Expand Down Expand Up @@ -227,9 +229,12 @@ and return:
}
```

Typically you could return the `results` array as part of a
poll (and hydrate the `friends`), but since the hook has no `friends` information, you
should instead remove it from the poll results.
To match the polling result to the hook result, you would modify this response to
remove the `friends` information, and return only the array of contacts, not the
enclosing object.

The polling result is not used when a user skips testing the Zap step. In that case,
Zapier uses the sample data, so the sample data must also match the hook data format.

See [Sample Data](./faq#output) in the FAQ for more details on this.

Expand All @@ -240,8 +245,8 @@ See [Sample Data](./faq#output) in the FAQ for more details on this.
## D007 - All URLs Should Be HTTPS

When handling customer data (which all Zapier functions do), it's strongly
encouraged that all communication take place securely. Using SSL is a big part of that, so
ensure your URLs have HTTPS as their protocol.
encouraged that all communication take place securely. Using SSL is a big part
of that, so ensure your URLs have HTTPS as their protocol.

If you need help setting up an SSL certificate for your API, we suggest
[Let's Encrypt](https://letsencrypt.org/).
Expand Down Expand Up @@ -389,7 +394,7 @@ See [Sample Data](./faq#output) in the FAQ for more details on this.

## D013 - Connects to a Non-Existing Search

[Search-Powered Fiels](https://platform.zapier.com/cli_docs/docs#search-powered-fields)
[Search-Powered Fields](https://platform.zapier.com/cli_docs/docs#search-powered-fields)
prompt users to set up a search step to populate the value of the field. It won't
work if the search key you specify doesn't exist.

Expand Down
20 changes: 17 additions & 3 deletions docs/_docs/versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,25 @@ If you're working with an integration that's currently private, the _Promote_ op

![Deprecate Zapier integration version](https://cdn.zapier.com/storage/photos/dd6acdd75278ecd733a5f3945ea641a2.png)

If you did introduce breaking changes to your integration and want existing users to switch to the new version, you can deprecate the old version. That will let your older integration and Zaps that use it continue to run—but they will include a `(Legacy)` tag in the Zapier editor to prompt users to re-build the Zap with the new integration. Additionally, when adding a new Zap step, Zapier will no longer show the older, deprecated version of your integration as an option.
If you introduce breaking changes to your integration and want existing users to switch to the new version, you can deprecate the old version.

To deprecate a version, select _Deprecate_ in the Versions menu, then select a date to deprecate the integration in the calendar drop-down. Choose a date between two weeks and a year from today, then click the _Deprecate_ button to confirm.
Deprecation is only recommended if the older integration version will eventually stop working, such as if the related API will be removed. Zapier is normally a "set it and forget it" experience for users, so use this feature carefully.

Zapier then shows a yellow exclamation mark beside that version in your integration’s versions menu, showing the date it will be deprecated when you hover over it. You’ll also see your user count as it goes down, switching from the old integration version to the new.
When you deprecate an integration version:

* The Zaps that use it will continue to run until the deprecation date. On the deprecation date, they will be paused.
* Zapier will send users with active Zaps a notification that they need to update their Zaps.
* When adding a new Zap step, Zapier will no longer show the deprecated version of your integration as an option.

Zap steps using this integration version will include a `Deprecated` tag in the Zapier editor, to help prompt users to re-build the Zap with the new integration.

To deprecate a version:

* Select _Deprecate_ in the Versions menu.
* Select a date to deprecate the integration version in the calendar drop-down. Choose a date between two weeks and a year from today when Zaps using that version will no longer work.
* Click the _Deprecate_ button to confirm.

Zapier then shows a yellow exclamation mark beside that version in your integration’s versions menu, showing the date it will be deprecated when you hover over it. You can also track your user count as it goes down, switching from the old integration version to the new.

## Delete Older Versions of Your Integration

Expand Down
2 changes: 1 addition & 1 deletion docs/_partner_api/embedding.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Include the additional options at the end of the script text with an ampersand,

`<script src="https://zapier.com/apps/embed/widget.js?services=APP&borderColor=green&limit=10&theme=dark"></script>`

> Need to embed the widget in a dynamic site or using a JavaScript framework? Try out our [troubleshooting section](/partners/zap-templates.md#troubleshoot-zap-template-embeds).
> Need to embed the widget in a dynamic site or using a JavaScript framework? Try out our [troubleshooting section](/partners/zap-templates#troubleshoot-zap-template-embeds).

<span id="iframe"><!-- helper anchor for simpler linking --></span>

Expand Down
Loading