Skip to content

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(docs): Integrations documentation #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29c304f
fix(docs): Integrations documentation
Geo25rey Mar 25, 2021
a80d47c
fix(docs): Minor edits on integrations
Geo25rey Mar 25, 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
42 changes: 42 additions & 0 deletions docs/docs/cli/integrations.md
View file
Open in desktop
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe replace this line with coming soon or similar?

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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.

Copy link
Contributor

Choose a reason for hiding this comment

The 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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is accessible thru the API tho

Copy link
Contributor

Choose a reason for hiding this comment

The 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.

Copy link
Contributor

Choose a reason for hiding this comment

The 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.
1 change: 1 addition & 0 deletions docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ nav:
- Daemon: cli/daemon-tutorial.md
- Custom Domains: cli/domains.md
- Workflow Variables: cli/workflow-variables.md
- Integrations: cli/integrations.md
#- API: api.md
#- SDK Clients: sdk-clients.md

Expand Down