Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(cli): Remove note on redirect_uri change after publish #774

Merged
merged 1 commit into from
Apr 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 1 addition & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1553,9 +1553,7 @@ <h3 id="oauth2">OAuth2</h3>
<li>Zapier makes a backend call to your API to exchange the <code>code</code> for an <code>access_token</code>.</li>
<li>Zapier stores the <code>access_token</code> and uses it to make calls on behalf of the user.</li>
<li>(Optionally) Zapier can refresh the token if it expires.</li>
</ol><blockquote>
<p>Note: When <a href="https://platform.zapier.com/private_integrations/private-vs-public-integrations">building a public integration</a>, the <code>redirect_uri</code> will change once the app is approved for publishing, to be more consistent with your app&#x2019;s branding. Depending on your API, you may need to add this new <code>redirect_uri</code> to an allow list in order for users to continue connecting to your app on Zapier. To access the new <code>redirect_uri</code>, run <code>zapier describe</code> again once the app is published.</p>
</blockquote><p>You are required to define:</p><ul>
</ol><p>You are required to define:</p><ul>
<li><code>authorizeUrl</code>: The authorization URL</li>
<li><code>getAccessToken</code>: The API call to fetch the access token</li>
</ul><p>If the access token has a limited life and you want to refresh the token when it expires, you&apos;ll also need to define the API call to perform that refresh (<code>refreshAccessToken</code>). You can choose to set <code>autoRefresh: true</code>, as in the example app, if you want Zapier to automatically make a call to refresh the token after receiving a 401. See <a href="#stale-authentication-credentials">Stale Authentication Credentials</a> for more details on handling auth refresh.</p><p>You&apos;ll also likely want to set your <code>CLIENT_ID</code> and <code>CLIENT_SECRET</code> as environment variables:</p>
Expand Down
2 changes: 0 additions & 2 deletions packages/cli/README-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -420,8 +420,6 @@ The OAuth2 flow looks like this:
4. Zapier stores the `access_token` and uses it to make calls on behalf of the user.
5. (Optionally) Zapier can refresh the token if it expires.

> Note: When [building a public integration](https://platform.zapier.com/private_integrations/private-vs-public-integrations), the `redirect_uri` will change once the app is approved for publishing, to be more consistent with your app’s branding. Depending on your API, you may need to add this new `redirect_uri` to an allow list in order for users to continue connecting to your app on Zapier. To access the new `redirect_uri`, run `zapier describe` again once the app is published.

You are required to define:

* `authorizeUrl`: The authorization URL
Expand Down
2 changes: 0 additions & 2 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -779,8 +779,6 @@ The OAuth2 flow looks like this:
4. Zapier stores the `access_token` and uses it to make calls on behalf of the user.
5. (Optionally) Zapier can refresh the token if it expires.

> Note: When [building a public integration](https://platform.zapier.com/private_integrations/private-vs-public-integrations), the `redirect_uri` will change once the app is approved for publishing, to be more consistent with your app’s branding. Depending on your API, you may need to add this new `redirect_uri` to an allow list in order for users to continue connecting to your app on Zapier. To access the new `redirect_uri`, run `zapier describe` again once the app is published.

You are required to define:

* `authorizeUrl`: The authorization URL
Expand Down
4 changes: 1 addition & 3 deletions packages/cli/docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1553,9 +1553,7 @@ <h3 id="oauth2">OAuth2</h3>
<li>Zapier makes a backend call to your API to exchange the <code>code</code> for an <code>access_token</code>.</li>
<li>Zapier stores the <code>access_token</code> and uses it to make calls on behalf of the user.</li>
<li>(Optionally) Zapier can refresh the token if it expires.</li>
</ol><blockquote>
<p>Note: When <a href="https://platform.zapier.com/private_integrations/private-vs-public-integrations">building a public integration</a>, the <code>redirect_uri</code> will change once the app is approved for publishing, to be more consistent with your app&#x2019;s branding. Depending on your API, you may need to add this new <code>redirect_uri</code> to an allow list in order for users to continue connecting to your app on Zapier. To access the new <code>redirect_uri</code>, run <code>zapier describe</code> again once the app is published.</p>
</blockquote><p>You are required to define:</p><ul>
</ol><p>You are required to define:</p><ul>
<li><code>authorizeUrl</code>: The authorization URL</li>
<li><code>getAccessToken</code>: The API call to fetch the access token</li>
</ul><p>If the access token has a limited life and you want to refresh the token when it expires, you&apos;ll also need to define the API call to perform that refresh (<code>refreshAccessToken</code>). You can choose to set <code>autoRefresh: true</code>, as in the example app, if you want Zapier to automatically make a call to refresh the token after receiving a 401. See <a href="#stale-authentication-credentials">Stale Authentication Credentials</a> for more details on handling auth refresh.</p><p>You&apos;ll also likely want to set your <code>CLIENT_ID</code> and <code>CLIENT_SECRET</code> as environment variables:</p>
Expand Down
Loading