Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex Teams. Please visit Webex for Developers to manage your apps.

Getting Started with the Webex API

The Webex APIs give you easy access to the Webex Platform to build Bots, Integrations, or Guest Issuer apps. If you're ready to start using the Webex APIs, keep reading.

anchorWhat's possible with the Webex APIs?

The Webex APIs provide your applications with direct access to the Cisco Webex Platform, giving you the ability to:

anchorAccounts and Authentication

To use the Webex REST API you'll need a Webex account backed by Cisco Webex Common Identity (CI). If you already have a Webex Teams account, you're all set. If you're using Webex Meetings, your site will need to be on Common Identity.

If you don't already have a Webex account, go ahead and sign up! You'll need an account to use the APIs and SDKs.

When making requests to the Webex REST API, an Authentication HTTP header is used to identify the requesting user. This header must include an access token. This access token may be a personal access token from this site (see below), a Bot token, or an OAuth token from an Integration or Guest Issuer application.

Our interactive API Reference uses your personal access token, which can be used to interact with the Webex API as yourself. This token has a short lifetime—only 12 hours after logging into this site—so it shouldn't be used outside of app development. When using this token, any actions taken through the API will be done as you. See below for your token:

Your Personal Access Token
Log in required for access token.
This limited-duration personal access token is hidden for your security.

To perform actions on behalf of someone else, you'll need a separate access token that you obtain through an OAuth authorization grant flow. Fortunately, we've baked OAuth support directly into the platform. With a few easy steps you can have a Webex Teams user grant permission to your app and perform actions on their behalf. For more information see the Integrations Guide.

After creating a Bot, the bot's access token is used with the API to perform actions as the bot.

anchorMethods & Content Types

The Webex Teams APIs are RESTful. In REST, each resource is represented by a base URL like /messages and the HTTP methods GET, POST, PUT and DELETE are used to request data and perform actions on those resources.

For methods that accept request parameters the platform accepts either application/json or application/x-www-form-urlencoded content types and currently only supports returning data in application/json format.

anchorNext Steps

We've tried to make it as simple as possible to explore and learn the Webex Teams APIs. Browse through the list of API endpoints under the Reference section in the menu on the left. Once you find an endpoint that looks interesting, go to that endpoint and give it a try! You can perform a request and see the results right in your browser.

If you prefer tutorials and structured lessons definitely check out the Learning Labs by Cisco DevNet.

Once you've learned the APIs and are ready to build an app you may be interested in using an SDK to eliminate some boilerplate. Check our list of SDKs over in the menu on the left side of this page. If your favorite language isn't listed don't worry, SDKs in new languages will be added regularly.

anchorGetting Help

If you ever get stuck, the Webex Developer Support team has you covered, standing by 24/7 to help.