-
Notifications
You must be signed in to change notification settings - Fork 8
[CON-3226] feat(goTo): extended goTo provider guide #621
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
Open
immdipu
wants to merge
7
commits into
main
Choose a base branch
from
goto-deep
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
0808ef4
docs(goTo): enhance documentation with supported actions and objects
immdipu 4af843b
docs(goTo): update supported objects and actions in documentation
immdipu 31e0a06
docs(goTo): clarify integration steps and credential requirements in …
immdipu 30708c1
fix typos
immdipu 1a9cb39
docs(goTo): correct link to example manifest file in documentation
immdipu 50870cb
add supported modules
immdipu 016d166
add note for default module
immdipu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,129 @@ | ||
| --- | ||
| title: "GoTo" | ||
| title: GoTo | ||
| --- | ||
|
|
||
| The GoTo connector supports GoTo products which have APIs with the root URL `api.getgo.com`, these include: | ||
| ## What's supported | ||
|
|
||
| - GoToWebinar | ||
| - GoToMeeting | ||
| ### Supported modules | ||
|
|
||
| ## What's Supported | ||
| The GoTo connector supports the following module: | ||
|
|
||
| ### Supported Actions | ||
| | Module | Description | Example | | ||
| | --- | --- | --- | | ||
| | `goTo` _(default)_ | Connects to GoTo products including Admin, Meetings, Webinars, Training, Corporate, Remote Support, and SCIM. | [sample](https://github.com/amp-labs/samples/blob/main/goto/amp.yaml) | | ||
|
|
||
| Since `goTo` is the default module, you don't need to set the `module` field in your manifest — it's applied automatically. | ||
|
|
||
| ### Supported actions | ||
|
|
||
| This connector supports: | ||
|
|
||
| - [Read Actions](/read-actions), including full historic backfill and incremental read for `historicalMeetings`, `webinars`, and `sessions`. For all other objects, a full read of the GoTo instance will be done per scheduled read. | ||
| - [Write Actions](/write-actions). | ||
| - [Proxy Actions](/proxy-actions), using the base URL `https://api.getgo.com`. | ||
|
|
||
| ## Before You Get Started | ||
|
|
||
| ### Supported objects | ||
|
|
||
| The GoTo connector supports reading from the following objects: | ||
|
|
||
| - [admin/groups](https://developer.goto.com/admin#tag/Groups/operation/Get%20Groups) | ||
| - [admin/users](https://developer.goto.com/admin#tag/Users/operation/Get%20Users) | ||
| - [attributes](https://developer.goto.com/admin#tag/Attributes/operation/Get%20All%20Attributes) | ||
| - [groups](https://developer.goto.com/Scim#tag/Groups/operation/getGroups) | ||
| - [historicalMeetings](https://developer.goto.com/GoToMeetingV1/#tag/Meetings/operation/getHistoricalMeetings) | ||
| - [licenses](https://developer.goto.com/admin#tag/Licenses/operation/Get%20Licenses) | ||
| - [portals](https://developer.goto.com/g2a-c#tag/Portals/paths/~1portals~1pages/get) | ||
| - [representatives](https://developer.goto.com/g2a-c#tag/Representatives/paths/~1representatives~1pages/get) | ||
| - [rolesets](https://developer.goto.com/admin#tag/Role-Sets/operation/Get%20Role%20Sets) | ||
| - [sessions](https://developer.goto.com/g2a-rs#tag/Sessions/paths/~1G2A~1rest~1v1~1sessions/get) | ||
| - [teams](https://developer.goto.com/g2a-c#tag/Teams/paths/~1teams~1pages/get) | ||
| - [upcomingMeetings](https://developer.goto.com/GoToMeetingV1/#tag/Meetings/operation/getUpcomingMeetings) | ||
| - [userSubscriptions](https://developer.goto.com/GoToWebinarV2/#tag/Webhooks/operation/getUserSubscriptions) | ||
| - [users](https://developer.goto.com/Scim#tag/Users/operation/getUsers) | ||
| - [webhooks](https://developer.goto.com/GoToWebinarV2/#tag/Webhooks/operation/getWebhooks) | ||
| - [webinars](https://developer.goto.com/GoToWebinarV2/#tag/Webinars/operation/getAllAccountWebinars) | ||
|
|
||
| The GoTo connector supports writing to the following objects: | ||
|
|
||
| - [admin/groups](https://developer.goto.com/admin#tag/Groups/operation/Add%20Group) | ||
| - [admin/users](https://developer.goto.com/admin#tag/Users/operation/Add%20Users) | ||
| - [groups](https://developer.goto.com/Scim#tag/Groups/operation/createGroup) | ||
| - [meetings](https://developer.goto.com/GoToMeetingV1/#tag/Meetings) | ||
| - [representatives](https://developer.goto.com/g2a-c#tag/Representatives/paths/~1representatives/post) | ||
| - [rolesets](https://developer.goto.com/admin#tag/Role-Sets/operation/Add%20Role%20Set) | ||
| - [teams](https://developer.goto.com/g2a-c#tag/Teams/paths/~1teams/post) | ||
| - [tickets](https://developer.goto.com/LogMeInResolve/#tag/Ticketing) | ||
| - [users](https://developer.goto.com/Scim#tag/Users/operation/createUsers) | ||
| - [userSubscriptions](https://developer.goto.com/GoToWebinarV2#tag/Webhooks/operation/createUserSubscriptions) | ||
| - [webhooks](https://developer.goto.com/GoToWebinarV2#tag/Webhooks/operation/createWebhooks) | ||
|
|
||
| ### Example integration | ||
|
|
||
| For an example manifest file of a GoTo integration, visit our [samples repo on GitHub](https://github.com/amp-labs/samples/blob/main/goto/amp.yaml). | ||
|
|
||
|
|
||
| ## Before you get started | ||
| goto | ||
| To integrate GoTo with Ampersand, you need to [Create a GoTo Account](https://developer.goto.com/signup/) and obtain the following credentials from your GoTo App: | ||
|
|
||
| - Client ID | ||
| - Client Secret | ||
|
|
||
| You will then use this credential to connect your application to Ampersand. | ||
| You will then use these credentials to connect your application to Ampersand. | ||
|
|
||
| ### Create a GoTo Account | ||
| ### Create a GoTo account | ||
|
|
||
| Here's how you can sign up for an GoTo account: | ||
| Here's how you can sign up for a GoTo account: | ||
|
|
||
| 1. Go to the [GoTo SignUp page](https://developer.goto.com/signup/). | ||
| 1. Go to the [GoTo sign-up page](https://developer.goto.com/signup/). | ||
| 2. Fill in the necessary details and register your account. | ||
|
|
||
| ### Creating an OAuth app in GoTo | ||
|
|
||
| Once your GoTo account is ready, you need to create an OAuth application to connect with Ampersand. Follow the steps below to create the OAuth app: | ||
|
|
||
| 1. Log in to Your [GoTo Account](https://identity.goto.com/login). | ||
|
|
||
| 2. Go to [Developers](https://developer.logmeininc.com/clients). | ||
|
|
||
| 3. Click on **Create a new client** | ||
|
|
||
| 4. Go to the **OAuth Apps** tab. | ||
|
|
||
| 5. Click the **Create App** button. | ||
|
|
||
| 6. Enter the following details in the **Create OAuth App** form: | ||
| ### Creating a GoTo OAuth app | ||
|
|
||
| 1. **App Name**: The name of the OAuth app. | ||
| 2. **App Description**: Description for the OAuth app. | ||
| 3. **Redirect URL**: Enter the Ampersand redirect URL: `https://api.withampersand.com/callbacks/v1/oauth` | ||
| Once your GoTo account is ready, create an OAuth application for Ampersand: | ||
|
|
||
| 1. Log in to your [GoTo account](https://identity.goto.com/login). | ||
| 2. Go to [GoTo developer clients](https://developer.logmeininc.com/clients). | ||
| 3. Click **Create a new client**. | ||
| 4. Open the **OAuth Apps** tab. | ||
| 5. Click **Create App**. | ||
| 6. Fill in the app details: | ||
| 1. **App Name**: Choose a name for the OAuth app. | ||
| 2. **App Description**: Add a short description. | ||
| 3. **Redirect URL**: Enter the Ampersand redirect URL: `https://api.withampersand.com/callbacks/v1/oauth`. | ||
| 7. Click **Next**. | ||
|
|
||
| 8. Select the applicable permissions. | ||
|
|
||
| 8. Select the permissions your app needs. | ||
| 9. Click **Save**. | ||
|
|
||
| You'll find the **Client ID** and **Client Secret** keys in your Oauth app details. These credentials are required for connecting your app to Ampersand, so be sure to note them carefully. | ||
| You'll find the **Client ID** and **Client Secret** keys in your OAuth app details. These credentials are required for connecting your app to Ampersand, so be sure to note them carefully. | ||
|
|
||
|  | ||
|
|
||
| ## Add GoTo App Details in Ampersand | ||
| ### Add your GoTo app info to Ampersand | ||
|
|
||
| 1. Log in to your [Ampersand Dashboard](https://dashboard.withampersand.com). | ||
|
|
||
| 2. Select the project where you want to add the GoTo App. | ||
| 2. Select the project where you want to add the GoTo app. | ||
|
|
||
|  | ||
|
|
||
| 3. Navigate to the **Provider Apps** section. | ||
|
|
||
| 4. Select **GoTo** from the Provider list. | ||
|
|
||
| 5. Enter the previously obtained **Client ID** and **Client Secret** in their respective fields. | ||
| 4. Select **GoTo** from the provider list. | ||
| 5. Enter the **Client ID** and **Client Secret** from your GoTo OAuth app. | ||
|
|
||
|  | ||
|
|
||
| 6. Click **Save Changes**. | ||
|
|
||
| ## Using the connector | ||
|
|
||
| To start integrating with GoTo: | ||
|
|
||
| - Create a manifest file like the [example above](#example-integration). | ||
| - Deploy it using the [amp CLI](/cli/overview). | ||
| - If you are using Read Actions, create a [destination](/destinations). | ||
| - Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component prompts the customer for GoTo OAuth authorization. | ||
| - Start using the connector. | ||
| - If your integration has [Read Actions](/read-actions), Ampersand delivers webhook messages. | ||
| - If your integration has [Write Actions](/write-actions), call the Write API. | ||
| - If your integration has [Proxy Actions](/proxy-actions), call Proxy API requests against `https://api.getgo.com`. | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove the entire section about modules because the builder doesn't need to act on this. So there's no need to tell them about it - it might just confuse them