Skip to main content
All CollectionsIntegrations & Partnerships
Getting Started With the Webex Events API
Getting Started With the Webex Events API

What the API does and how to get started

Daniel Murphey avatar
Written by Daniel Murphey
Updated over a week ago

If you have a developer on your team who knows how to use a GraphQL API, the Webex Events API could be your gateway to powerful Event and product setup and management automations, third-party platform integrations, powerful multi-event data dashboards, and more.

What the Webex Events API can do

Put simply, an API is a programming interface that developers can use to get data from or put data into an online platform — in this case, Webex Events.

The API's capabilities can be simplified to four basic concepts:

  • Create something that didn't exist before, like an attendee, a Session, or a whole Event.

  • Update anything the API can be used to create, plus a few more things. For example, the API can be used to create a new attendee, and then edit that attendee's name, email, status, groups, phone numbers, and social accounts.

  • Read information about anything the API can be used to create or edit, plus some things it can't.

  • Delete anything the API can be used to create, with some exceptions.

Keep these concepts in mind while reading the 'Working with developers' section of this article.

How to get started

1. Get access to the API

If you're a Webex Suite Enterprise Agreement (Suite EA) customer who already has Webex Events activated, you automatically get access to the Webex Events API! For all other customers, talk to your Webex Events contact or our support team to learn about accessing the API.

2. Create an API key

Now you need to create a new API key for your developers to use. When you have access to the API, a new tab is added to the 'Org settings' page in the Webex Events platform. Here's how to access the new tab and create your first key:

💡 Keep in mind, only organization admins can access the API page.

  1. From anywhere in the Webex Events platform, click your profile image in the top right corner of the screen, then select Organization settings from the drop-down.

  2. On the Org settings page, click the API tab in the left menu. This takes you to the API dashboard where you can review API usage, export usage logs, manage keys, and access our API documentation.

  3. Click Create key.

  4. In the ‘Create new key’ modal enter a Label for the API key that explains what it will be used for.

  5. The API version drop-down will already have the current version selected, so simply click Save. This reveals the API key.

  6. Click the Copy button next to the key and paste the key into a secure document to ensure it's never lost.

    ⚠️ WARNING! This is the only time the full API key can be accessed. After you close the modal, the full key can't be read again.

  7. After you've copied and saved the key, click the Close button.

In most cases, you only need one API key. However, in situations where you're working with multiple teams, you might want to create a key for each team. Talk to your developers about your specific use cases to figure out the best solution.

3. Invite developers to access the API

When you create your first API key, a new API team is automatically created in the Webex Events platform. Giving your developers access to try out the Webex Events API is as simple as inviting them to that API team. Follow the instructions in our article about managing teams, members, and credits to learn how.

People on your API team don't have access to the rest of the Webex Events platform the way organizers do. Instead, API team members have access to an API "sandbox" where they can test what they're building without affecting real-world data. If you want developers to also have access to some or all of your Events and Apps in the Webex Events platform, invite them to relevant non-API teams.

4. Prepare an Event

Because the API can't activate any of the products in an Event, such as the Event App and Onsite, you must activate each product you intend to use in your Event, filling in the basic required information.

Working with developers

It's important for you to clearly communicate with your developers so they can build what you need. This means you need to know what parts of the Webex Events platform the API can access. Keep reading to learn exactly what the API can access and control, plus a few tips to help you "speak the same language" as your developer.

When you're familiar with the basic capabilities, you can start to talk to your developer about building tools and automations with the API.

Teams and organizations

  • Create, update, read, and delete teams and team members

Events

  • Create, update, clone, and read. Events can't be deleted.

Attendees

  • Create, update, read, assign to Sessions, assign to groups, and delete social account information (phone number, social account handles, etc). Attendees can’t be deleted, though they can be blocked.

Questions

  • Create, update, read, and delete

Tip: In the API, questions are called "custom fields"

Groups

  • Create, update, read, and delete both exclusive and non-exclusive groups

Sessions

  • Create, update, read, and delete

Locations

  • Create, update, read, and delete

Tip: In the API, locations are called "regions".

Branded Apps

  • Read Branded App names, statuses, and the names of assigned Events

Event App

  • Read Basics, Appearance, and Web App settings plus Video Center Recordings information

  • Create, update, read, and delete the following Event App features and their items, where applicable:

    • Agenda

    • Sponsors

    • Speakers

    • Exhibitors

    • Live Stream

    • Attendees

    • Custom List

    • Single Item

    • Web Link

    • Web List

    • My QR Code

💡 Keep in mind, you must manually add and configure any Event App features not listed above.

Tip: In the API, features are called "components".

Registration

  • Read Basics, Appearance, and Settings information, including checkout settings

  • Create, read, update, and delete tickets, forms, questions, promo codes

  • Create, read, and update orders

  • Send order and ticket confirmation emails

  • Mark check or invoice orders as paid

  • Update order purchaser information

  • Cancel and refund tickets

  • Create, read, update, delete, pause, and resume promo codes

  • Create, read, update, and delete taxes

Tip: In the API, questions are called "custom fields".

Onsite

  • Read and update Basics and Onsite App information

Lead Retrieval and Live Display

  • Read whether the product is active or published in the Event

Things to know

  • We'll occasionally release new versions of the API with improvements and fixes. We'll continue to support old versions long enough for everyone to transition the the new version. We'll send email updates about new versions, upcoming old version deprecation dates, and official deprecations.

  • API requests are metered and limited to prevent abuse.

  • Communities are also supported for Suite customers.

Did this answer your question?