Skip to content
Open
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
5 changes: 5 additions & 0 deletions src/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@
"provider-guides/crunchbase",
"provider-guides/customerJourneysApp",
"provider-guides/customerJourneysTrack",
"provider-guides/webex",
"provider-guides/delighted",
"provider-guides/discord",
"provider-guides/discourse",
Expand Down Expand Up @@ -530,6 +531,10 @@
{
"source": "/glossary",
"destination": "/terminology"
},
{
"source": "/provider-guides/webex",
"destination": "/provider-guides/webex"
}
]
}
5 changes: 5 additions & 0 deletions src/generate-docs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,10 @@ const baseConfig = {
source: "/glossary",
destination: "/terminology"
},
{
source: "/provider-guides/webex",
destination: "/provider-guides/webex"
},
],
footerSocials: {
linkedin: "https://www.linkedin.com/company/withampersand",
Expand Down Expand Up @@ -325,6 +329,7 @@ const baseConfig = {
"provider-guides/crunchbase",
"provider-guides/customerJourneysApp",
"provider-guides/customerJourneysTrack",
"provider-guides/webex",
"provider-guides/delighted",
"provider-guides/discord",
"provider-guides/discourse",
Expand Down
Binary file added src/images/provider-guides/webex.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
105 changes: 105 additions & 0 deletions src/provider-guides/webex.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
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 Admin 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)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think meetings can be accessed with ordinary user level account.
Some objects require organization-level admin scopes, while others can be accessed with user-level scopes. I think we should mention this in some way.

Admin API is a superset. Maybe there are some Webex docs that we can point out customers to decide what account type do they need. You have a <Note> below which is helpful.

Copy link
Collaborator

Choose a reason for hiding this comment

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

(Read,Write) is missing space, unlike other lines.


## 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 Suite integration requires organization-level access in Cisco Webex.
Copy link
Collaborator

Choose a reason for hiding this comment

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

As per the comment above, maybe link some docs about Admin Suite integration.

Ensure your integration is authorized with the required organization (admin)
scopes, as many supported objects are only accessible to organization
administrators.
</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**.

![Alt text](/images/provider-guides/webex.gif)
Copy link
Collaborator

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.


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.

![Ampersand Project Selection](/images/provider-guides/31a6a12-Ampersand.png)

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.