Skip to content
This repository has been archived by the owner on Nov 29, 2024. It is now read-only.

Commit

Permalink
Merge pull request #575 from zapier/platform_updates
Browse files Browse the repository at this point in the history
PLATSUP-1013_platform_docs_updates
  • Loading branch information
marinahand authored Jan 30, 2024
2 parents f384c55 + 47c2a3c commit 0e7588a
Show file tree
Hide file tree
Showing 12 changed files with 33 additions and 12 deletions.
8 changes: 7 additions & 1 deletion docs/_build/actions/action.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,10 @@ Most useful searches return one individual item that will likely be needed in an

The [output returned](https://platform.zapier.com/build/response-types) by a _search_ should be a JSON-formatted array sorted with the best match first. Only the first item will be returned. For no match found, a `200` with an empty array must be returned. If your API returns a `404` error for searches without results, add custom code to your API call to replace it with an empty array.

Zapier strongly recommends against action steps that delete or remove data. To prevent data loss, action steps should only add or update data. If you are considering adding a delete action to your app, consider alternative actions for items such as deactivating, unsubscribing, or canceling, instead of deleting items completely.
## 3. Delete actions

Zapier recommends careful consideration of action steps that fully delete or remove data. To prevent data loss, action steps should only add or update data.

If you are considering adding a delete action to your app, consider alternative actions for items such as deactivating, unsubscribing, or canceling, instead of deleting items completely.

If you do add a delete action, make sure to include a `Copy` field to clarify to users that the action is irreversible once the API request is made.
10 changes: 5 additions & 5 deletions docs/_build/authentication/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ All Zapier integrations that can access or add private data for users require au

Zapier supports the following five authentication schemes in the Platform UI, each with their own settings:

- API Key
- OAuth v2
- Session Auth
- Basic Auth
- Digest Auth
- [API Key](https://platform.zapier.com/build/apikeyauth)
- [OAuth v2](https://platform.zapier.com/build/oauth)
- [Session Auth](https://platform.zapier.com/build/sessionauth)
- [Basic Auth](https://platform.zapier.com/build/basicauth)
- [Digest Auth](https://platform.zapier.com/build/digestauth)

![Zapier Authentication](https://cdn.zappy.app/37e7829169eb2e07278d512c174cd708.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/_build/fields/field-definitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ Dynamic fields make a request to your app's API, showing the returned data in a

## Line item groups

Line item groups allows for a set of input fields to create line items. When a comma separated list is entered in the field, each list item would create a new separate object in your app. Typically used to add multiple lines of similar details to an app, for example in invoice and accounting apps. Only available in Platform UI actions.
Line item groups allow users to input line items provided from the trigger or prior action. Those items will then be sent in the request as an array of individual objects. Users cannot input comma separated values into a line item field, they need to be provided from the trigger or a prior action in line item format for them to be sent this way. Typically used to add multiple lines of similar details to an app, for example in invoice and accounting apps. Only available in [Platform UI actions](https://platform.zapier.com/quickstart/ui-vs-cli).
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Embed insights definitions
order: 6
order: 4
layout: post-toc
redirect_from:
- /manage/analyze-integration-performance#embed-insights-definitions
- /manage/analyze-integration-performance#practical-applications-of-embed-insights
- https://platform.zapier.com/manage/embed-insights
---

# Embed insights definitions
Expand Down
2 changes: 1 addition & 1 deletion docs/_manage/account-and-team/add-team.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ redirect_from:

# Invite team members to your integration

You can add team members to your integration to collaborate, contribute, and view analytics data for your integration on the Developer Platform. Your integration team can have up to 100 team members, regardless of whether your integration is Private or Public. Team members added to your integration will be assigned one of the following roles:
Integrations do not have a dedicated owner, instead they are managed by a team that can be modified as needed. Add team members to your integration to collaborate, contribute, and view analytics data for your integration on the Developer Platform. Your integration team can have up to 100 team members, regardless of whether your integration is Private or Public. Team members added to your integration will be assigned one of the following roles:

- **Admin**: Admins are granted read and write access to the integration. This role is ideal for developers and individuals actively involved in building and maintaining the integration.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Definitions for each of the metrics provided in the integration dashboard below:
| **Usage by trigger** | Number of current live Zaps (Zaps turned on), paused Zaps (Zaps turned off), and total Zaps for each trigger. | By integration version |
| **Usage by action** | Number of current live Zaps (Zaps turned on), paused Zaps (Zaps turned off), and total Zaps for each action. | By integration version |

Public app integrations also have [visibility into embed insights](https://platform.zapier.com/embed/embed-insights).

## Best practices

Expand Down
2 changes: 1 addition & 1 deletion docs/_manage/integration-performance/user-feedback.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Problems with your public integration, authentication and API calls will be logg

- Affected user counts on issues typically underrepresent the actual totals, as only a small portion of all users facing an issue take the time to contact Zapier Support.

## 2. Respond to issues in a timely mannner
## 2. Respond to issues in a timely manner

- Reply to the Zapier team about the issue within the _Bugs & Feature Requests_ page to keep communications consistent for both your team and ours. These issues and comments are not visible to affected users; and users will only be notified when an issue is verified as closed/resolved by Zapier Support.

Expand Down
2 changes: 2 additions & 0 deletions docs/_manage/versions/deprecate.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ redirect_from:

Deprecation is an optional process that allows you to set a date from which a non-public version of your integration will no longer be updated. 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. Only if the older version will no longer function, should it be deprecated. Please note that deprecating a version is significantly more disruptive to our mutual users than migrating to the latest promoted version, or than leaving users on an older (now) private version if migration is not possible.

When users are left on an older private version, they will see a [prompt in the Zap editor](https://help.zapier.com/hc/en-us/articles/18755649454989-Update-to-the-latest-app-version-in-Zaps) to optionally encourage them to make the update, instead of any deprecation communications or Zap disruptions.

## What happens after setting a version to deprecate

### 1. Email notification
Expand Down
4 changes: 3 additions & 1 deletion docs/_manage/versions/migrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ Zapier recommends migrating a small portion of your existing users to the new in

Major changes would cause active Zaps to error and potentially turn off. They would require users to manually update the Zap in order to get it working again. Learn more about [breaking changes to your integration](https://platform.zapier.com/manage/making-changes), best practices and the user impacts.

Zapier recommends not to attempt to migrate users for major changes. Instead [deprecate the version](https://platform.zapier.com/manage/versions-ui#deprecating-versions) to prompt users to [manually update to the latest integration version](https://help.zapier.com/hc/en-us/articles/18755649454989-Update-to-the-latest-app-version-in-Zaps). Please note that deprecating a version is significantly more disruptive to our mutual users than migrating to the latest promoted version, or than leaving users on an older (now) private version when migration is not possible.
Zapier recommends not to attempt to migrate users for major changes. Instead [deprecate the version](https://platform.zapier.com/manage/versions-ui#deprecating-versions) to prompt users to [manually update to the latest integration version](https://help.zapier.com/hc/en-us/articles/18755649454989-Update-to-the-latest-app-version-in-Zaps). Please note that deprecating a version is significantly more disruptive to our mutual users than migrating to the latest promoted version, or than leaving users on an older (now) private version when migration is not possible.

When users are left on an older private version, they will see a [prompt in the Zap editor](https://help.zapier.com/hc/en-us/articles/18755649454989-Update-to-the-latest-app-version-in-Zaps) to encourage them to make the update themselves.

## Migrate users to new version with Platform UI

Expand Down
6 changes: 5 additions & 1 deletion docs/_publish/launch-process/public-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Learn more about creating [Zap templates](https://platform.zapier.com/publish/za

The best way to ensure users are able to discover your Zapier integration is to surface your integration where users are looking at it. By embedding Zapier in your product, you can create end-to-end user experience, helping your customers discover available integrations within your product without having to leave your app.

Learn more about [embedding Zapier](https://platform.zapier.com/embed/overview).
Learn more about [embedding Zapier](https://platform.zapier.com/embed/embed-benefits).

### **Grow active usage**

Expand All @@ -122,6 +122,10 @@ With the Zapier Issue Manager, you have the ability to conveniently address bugs

Learn more about [Zapier Issue Manager](https://platform.zapier.com/publish/zapier-issue-manager).

### **Exit Beta early by embedding your integration**

When activity from your integration is detected through one of the Zapier [embed tools](https://platform.zapier.com/embed/embed-benefits), you’ll exit Beta the next business day and unlock your [Partner Program benefits](https://zapier.com/developer-platform/partner-program). The simplest option is to feature your Zap templates in a launch announcement. Additionally, you can present a dynamic gallery of the 6,000+ applications that are now compatible with your app for creating workflows.

## **6. Public phase**

After 90 days in public beta, your integration will become public:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ When building an integration on the Zapier Platform, you must specify the intend
* Public integration: For access to all Zapier customers and published in the [Zapier App Directory](https://zapier.com/apps).
* Private integration: For personal, internal (e.g. with your team) or controlled-access use.

- Building a private or public integration on the Zapier Platform is free.
- There are no fees for sharing or publishing an integration.
- Users of your integration are responsible for their own Zapier plans and billing.
- Partners do not incur fees as a result of the usage of their integration.

Both private and public integrations can connect to Zapier’s app directory of over [{{ site.partner_count }} integrations](https://zapier.com/apps). Depending on your intended audience, there will be different features available and limitations to what the integration can do.

> **Note**: The intended audience is different from your integration’s status. All integrations, regardless of intent, start with a private status. Learn more in [Zapier integration publishing requirements](https://platform.zapier.com/publish/integration-publishing-guidelines).
Expand Down

0 comments on commit 0e7588a

Please sign in to comment.