anchorWhat are webhooks?

A webhook is an HTTP notification sent to your application when an event occurs. You register the events you want to receive and an HTTPS endpoint in your application. When a matching event occurs, Webex sends a request to that endpoint with a JSON payload describing the event.

Webhooks reduce the need to repeatedly check an API for changes. They work alongside Webex APIs: a notification can start a workflow, and your application can call an API to retrieve more details or take the next action. For example, a message notification identifies the message; your application can then fetch its content with an authorized API request.

anchorWhat can you build?

• Respond to a new message in a Webex space with a bot or integration.
• Start a follow-up workflow when a meeting ends.
• Process a Contact Center recording or transcript when it becomes available, or alert your team to a flow failure.
• Start customer onboarding when an administrator authorizes your Service App.

Your application needs permission to subscribe to the selected events and access any related data. Event availability, registration, and delivery rules vary by product. Choose the guide below that matches the activity you want to follow.

anchorChoose a webhook family

An application can use more than one family. For example, a Contact Center application can receive platform serviceApp authorization events through the Webhooks API and agent events through Contact Center Subscriptions.

anchorHow webhook delivery works

Webhooks send HTTP POST notifications to a destination your application exposes. Register the events you need, store the registration configuration and signing secret, verify each delivery, accept it durably, and process it idempotently. Use the selected family's guide for its acknowledgement rules and recovery behavior.

The Workspace Integration and Webex Connect guides define their own setup, payload, and authentication contracts. Select verification rules from the registration family; a shared HTTP header name alone does not identify the contract.

anchorIncoming integrations

To trigger Webex Connect flows or rules from an external application, see Webex Connect inbound webhooks.

anchorChoose a task

• Create, inspect, update, or delete a registration: use the registration guide for the selected family.
• Authenticate a delivery or diagnose missing events: use that family's receiver guide.
• Find an event name, supported filter, resource version, or payload field: use its event reference.
• Retrieve compliance activity for archiving: see Events and Archiving. The Events API is a separate retrieval workflow.

anchorSections moved from this guide

Existing bookmarks are retained below. Follow the link for the detailed instructions.

Overview

Orgadmincompliance officer level webhooks

Choosing applications vs serviceapp webhooks

Webex webhooks

Handle duplicate notifications

Filtering webhooks

Resources events filters

The firehose webhook

Single resource firehose

All resource firehose

Creating a webhook

Request parameters

Applications webhook examples

Troubleshooting applications webhooks

User level scopes for meeting related webhooks

Organizationadmincompliance officer level scopes for meeting related webhooks

Handling requests from webex

Using the data property

Handling sensitive data

Authenticating requests

Data synchronization meetings

Disabled webhooks

Find the migrated reference.

Find the migrated reference.

Find the migrated reference.

Find the migrated reference.

Find the migrated reference.