diff --git a/src/docs.json b/src/docs.json index a8c38763..7584c2a4 100644 --- a/src/docs.json +++ b/src/docs.json @@ -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", @@ -530,6 +531,10 @@ { "source": "/glossary", "destination": "/terminology" + }, + { + "source": "/provider-guides/webex", + "destination": "/provider-guides/webex" } ] } \ No newline at end of file diff --git a/src/generate-docs.ts b/src/generate-docs.ts index 5cf22a64..3a93334a 100644 --- a/src/generate-docs.ts +++ b/src/generate-docs.ts @@ -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", @@ -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", diff --git a/src/images/provider-guides/webex.gif b/src/images/provider-guides/webex.gif new file mode 100644 index 00000000..87ee9cc1 Binary files /dev/null and b/src/images/provider-guides/webex.gif differ diff --git a/src/provider-guides/webex.mdx b/src/provider-guides/webex.mdx new file mode 100644 index 00000000..f5a825bb --- /dev/null +++ b/src/provider-guides/webex.mdx @@ -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) + +## 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 + + + The Admin Suite integration requires organization-level access in Cisco Webex. + Ensure your integration is authorized with the required organization (admin) + scopes, as many supported objects are only accessible to organization + administrators. + + +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) + +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.