-
Notifications
You must be signed in to change notification settings - Fork 6
[CON-2760] feat: Add Cisco Webex #429
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| --- | ||
| title: Webex | ||
| --- | ||
|
|
||
| ## What's Supported | ||
|
|
||
| ### Supported Actions | ||
|
|
||
| This connector supports: | ||
|
|
||
| - [Read Actions](/read-actions), including full historical backfill and incremental read. | ||
| - [Write Actions](/write-actions), including create and update operations. | ||
| - [Proxy Actions](/proxy-actions), using the base URL `https://webexapis.com`. | ||
|
|
||
| ### Supported Objects | ||
|
|
||
| The Webex connector supports the following objects from the API: | ||
|
|
||
| - [people](https://developer.webex.com/docs/api/v1/people/list-people) (Read, Write) | ||
| - [groups](https://developer.webex.com/admin/docs/api/v1/groups) (Read, Write) | ||
| - [roles](https://developer.webex.com/docs/api/v1/roles/list-roles) (Read only) | ||
| - [events](https://developer.webex.com/docs/api/v1/events/list-events) (Read only) | ||
| - [organizations](https://developer.webex.com/docs/api/v1/organizations/list-organizations) (Read only) | ||
| - [reports](https://developer.webex.com/admin/docs/api/v1/reports/list-reports) (Read only) | ||
| - [meetings](https://developer.webex.com/meeting/docs/meetings) (Read, Write) | ||
|
|
||
| ## Before you get started | ||
|
|
||
| To integrate Webex with Ampersand, you will need [a Cisco Webex Account](https://www.webex.com/signup). | ||
|
|
||
| Once your account is created, you'll need to create an integration in Webex and obtain the following credentials from your integration: | ||
|
|
||
| - Client ID | ||
| - Client Secret | ||
|
|
||
| You will then use these credentials to connect your application to Ampersand. | ||
|
|
||
| ### Creating a Webex Integration | ||
|
|
||
| <Note> | ||
| The Admin API is a superset of user-level APIs. Some objects (such as events, | ||
| organizations, and reports) require organization-level admin scopes, while | ||
| others (such as meetings) can be accessed with user-level scopes. Refer to the | ||
| [Webex API documentation](https://developer.webex.com) to determine which | ||
| account type and scopes are required for your use case. | ||
| </Note> | ||
|
|
||
| Follow the steps below to create a Cisco Webex integration and add the Ampersand redirect URL to the integration: | ||
|
|
||
| 1. Log in to your [Webex Developer Portal](https://developer.webex.com/) account. | ||
|
|
||
| 2. Click **My Apps** in the top navigation. | ||
|
|
||
| 3. Click **Create a New App**. | ||
|
|
||
| 4. Select **Integration** as the app type. | ||
|
|
||
| 5. Enter your **App Name**. | ||
|
|
||
| 6. Enter a **Description** for your integration. | ||
|
|
||
| 7. Enter Ampersand's **Redirect URI**: `https://api.withampersand.com/callbacks/v1/oauth`. | ||
|
|
||
| 8. Under **Scopes**, select the necessary [Scopes](https://developer.webex.com/create/docs/integrations#scopes) for your integration. | ||
|
|
||
| 9. Click **Add Integration**. | ||
|
|
||
|  | ||
|
|
||
| On the next screen, you'll see a **Client ID** and **Client Secret** have been generated. | ||
|
|
||
| You'll use these credentials while connecting your app to Ampersand. | ||
|
|
||
| ## Add Your Webex App Info to Ampersand | ||
|
|
||
| 1. Log in to your [Ampersand Dashboard](https://dashboard.withampersand.com). | ||
|
|
||
| 2. Select the project where you want to create a Webex integration. | ||
|
|
||
|  | ||
|
|
||
| 3. Select **Provider apps**. | ||
|
|
||
| 4. Select _Webex_ from the **Provider** list. | ||
|
|
||
| 5. Enter the previously obtained _Client ID_ in the **Client ID** field and the _Client Secret_ in the **Client Secret** field. | ||
|
|
||
| 6. Click **Save changes**. | ||
|
|
||
| ## Using the connector | ||
|
|
||
| To start integrating with Webex: | ||
|
|
||
| - Create a manifest file. | ||
|
|
||
| - Deploy it using the [amp CLI](/cli/overview). | ||
|
|
||
| - If you're using Read Actions, create a [destination](/destinations). | ||
|
|
||
| - Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. This UI component will prompt the customer for OAuth authorization. | ||
|
|
||
| - Start using the connector! | ||
|
|
||
| - If your integration has [Read Actions](/read-actions), you'll start getting webhook messages. | ||
| - If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API. | ||
| - If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls. | ||
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.
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.
The gif is missing the mouse cursor so in the first steps it looks like jumping. But that is my preference.
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.
my recorder keeps removing the cursor on my distro :(