-
Notifications
You must be signed in to change notification settings - Fork 4
fix(docs): Integrations documentation #66
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
|
|
||
| ## Overview | ||
|
|
||
| Mailscript provides integrations with external services such as Google Drive and Zoom. These integrations provide validated OAuth tokens to Mailscript Actions after the integrations are setup. The provided OAuth tokens can be used to interact directly with the integrated service. | ||
|
|
||
| ## Google Drive | ||
|
|
||
| The Google Drive Integration provides an OAuth token with the permissions defined by [drive.files](https://www.googleapis.com/auth/drive.file). This allows for viewing and managing Google Drive files and folders that you have opened or created with this app. | ||
|
|
||
| ### Setup | ||
|
|
||
| To setup the Google Drive Integration, first ensure you are logged in under the CLI with: | ||
| ``` | ||
| mailscript login | ||
| ``` | ||
|
|
||
| Then, add the Google Drive Integration with the following: | ||
| ``` | ||
| mailscript integrations:add --gdrive | ||
| ``` | ||
|
|
||
| This will open up your default web browsers with a prompt to sign in to Google. | ||
|
|
||
| ### Usage | ||
|
|
||
| To access the Google Drive Integration from an Action, [Variable Interpolation]() is required on `integrations.google`, which returns the Integration's OAuth token. | ||
|
|
||
| Note: The Integration's OAuth token is only provided to Webhook-typed Actions. | ||
|
|
||
| ## Zoom | ||
|
|
||
| The Zoom Integration provides an OAuth token. This allows for full access to the Zoom API with your authority. | ||
|
|
||
| Note: This Integration is not currently supported. | ||
|
|
||
| ### Setup | ||
|
|
||
| There is currently no easy way to setup the Zoom Integration and is not currently supported. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe replace this line with coming soon or similar?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure if this is coming soon. Last I heard, there aren't plans on going further with it for the time being.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So maybe just remove the mention of Zoom entirely if it not something the user can use.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It is accessible thru the API tho
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @Geo25rey I would suggest adding some mention of the API in that case otherwise it would appear like we are offering a feature that isn't quite ready yet. Better to not confuse the reader with this.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. My previous comment here is the only major thing that stands out. Maybe replace with coming soon? |
||
|
|
||
| ### Usage | ||
|
|
||
| Since the Zoom Integration is not suppported yet, Zoom OAuth tokens are not exposed to Mailscript Actions. | ||
Uh oh!
There was an error while loading. Please reload this page.