Postman collections for Webex REST APIs
Switch branches/tags
Nothing to show
Clone or download

README.md

Postman collections for Webex Teams

This repo gathers collections for the Webex Teams. Check the postman-xapi repo if looking for collections for Webex Devices.

  • REST API: Messages, Spaces, Teams, People, Webhooks... everything accessible from an access token, with no admin priviledges
  • admin REST API: Organizations, People creation and updates, Roles, Licenses, and Events. These admin related features are accessible only from an access token with admin priviledges
  • 1-1 space: Create a 1-1 space by sending a direct message

If you're new to Postman, you're only a few steps away from getting the full benefits of the collections:

  1. import and configure a collection
  2. generate code for your favorite language
  3. run collections as part of your CI/CD process via the newman command
  4. publish documentation via documenter.

We welcome pull requests for enhancements of existing collections, as well as contributions of collections that proved to be handy for you. When submitting a new collection, please ensure it leverages a {{access_token}} variable to ease environments sharing among collections. Thank you!

all-resources-scripted

Run in Postman

The collection implements the public resources for the Webex Teams REST API , with direct links to the official API documentation.

public resources

Worth mentionning that the collection is scripted so that you can run REST calls in a row for any given resource:

  • as you run REST queries from top to bottom, newly created resource identifiers are automatically retreived and injected into your postman environment as temporary variables,
  • so that the next REST query will look from the postman environment, and execute in the context of the previous query. For example, you'll add a message into the space you just created in the previous step.
  • at the end of each scenario (embedded in individual collection folders), we've added requests to free newly created resources so that you'll end up in the same state as before running the queries in postman.

Enough talk, let's practice:

  • import the all-resources-scripted collection,
  • create or select a postman environment that contains a {{access_token}} variable,
  • now, you're ready to invoke the API: for example, go to the Messages folder, and run the requests from top to bottom.

messages

Now, what about generating some code for your favorite language ?

Take the Generate Code Guide and have this Node.js code snippet automatically generated for the API Resource "List spaces":

generate code

Note that the collection is also rendered in HTML for quick browsing via Postman Documenter.

admin-api

Run in Postman

The collection illustrates the REST API Administration Resources, with direct link to the Admin API documentation.

Note that the collection is also rendered in HTML for quick browsing via Postman Documenter.

admin-api

The People folder is populated with pre-request and post-request scripts in order to ease the creation of random accounts.

admin-api

direct-space

Illustrates how to create a 1-1 space by sending a direct message to a Webex user account's email address.

Also illustrates the fact that it is not possible to DELETE nor LEAVE 1-1 spaces via the API (as of October 2016)

direct-space