- Home
- /
- Article
Thanks for your feedback.
Enable webhooks for alerts in Control Hub
In this article
Feedback?You can set up a webhook callback URL so that alerts show up in third-party applications.
Overview
Control Hub offers an Alerts Center which allows you to create, manage, and receive alerts on various events across your Webex deployment through multiple delivery channels. The delivery channels that Alert Center currently support are through email, Webex App spaces, and in Control Hub.
Now, webhooks is being added as another delivery channel. Webhooks allow admins to consume generated alerts in different collaboration apps, ticketing systems in IT service management (ITSM) tools, custom dashboards, or any other applications that support webhooks.
The admin can specify a webhook callback URL in Control Hub. After providing a callback URL, you can select the webhook option as an additional delivery channel in the rules for new or existing alerts. See below for steps on how to configure webhooks.
Here's an example of what the JSON element for an alert webhook looks like:
{
"orgId": "1ab23cde-4567-890f-1234-gh56ijk07l891",
"title": "title",
"summary" : "notification for a test alert",
"actionUrl" : "www.actionURL.com",
"severity" : "HIGH",
"eventType" : "created",
"resourceType": "ControlHubAlerts",
"type": "Meeting",
"subtype": "Live Meeting Monitoring",
}
Set up a webhook callback URL
You must first add a webhook callback URL before you can enable rules to use webhooks.
| 1 |
Sign in to Control Hub and go to Organization Settings. |
| 2 |
Scroll to the Webhook configuration section. |
| 3 |
Toggle the Configure the webhook URL switch to on. A pop-up window appears. |
| 4 |
Enter the webhook URL that you want to use. You can also choose to add a secret token for the webhook. View this blog to learn more about secret tokens. 
|
| 5 |
Select Validate. If validation fails, check to make sure the webhook URL and secret token are correct. Click Try again once you've finished checking. |
| 6 |
Select Save. |
Enable webhook in a rule
After setting up a webhook URL, you can set up rules to use webhooks as a delivery channel.
| 1 |
From the customer view in https://admin.webex.com, go to Alerts center, and click Manage. |
| 2 |
In the All rules tab, select a rule. |
| 3 |
In the Delivery Method section, check the Webhook checkbox. 
|
| 4 |
Click Save. |
Webex Meetings webhook field reference
The alert content depends on how you have chosen to receive the alerts. In the tables in this article, we cover the contents in each alert.
Device as a target for the alert
| Field name | Data type | Example |
|---|---|---|
| CONFERENCE_ID | Long | 111222333444555666 |
| DEVICE_URL | HTTP URL pair |
|
| ERROR_REASON | String | BOTH_OVER_THRESHOLD |
| LINK | HTTP URL | https://admin.webex.com/diagnostic/loadingDetail/123456789012345678 |
| ORGANIZATION_NAME | String | Example Org |
| REFERENCE_ID | String | SGDAC_05-Meeting Pod 19 |
| participant_deviceUrl | HTTP URL pair |
|
| report_audioMainReport_rxE2eLostPercent__threshold | Percent | 8% |
| report_audioMainReport_rxE2eLostPercent__timestamp1_utc | ISO timestamp | Tue, 18 Jun 2024 08:07:50 UTC |
| report_audioMainReport_rxE2eLostPercent__timestamp2_utc | ISO timestamp | Tue, 18 Jun 2024 08:07:50 UTC |
| report_audioMainReport_transportType | String | UDP |
| report_intervalMetadata_serverRegion | String | United States |
| report_audioMainReport_rxE2eLostPercent | Percent | 16% |
User as a target for the alert
| Field | Data type | Example |
|---|---|---|
| CONFERENCE_ID | Long | 111222333444555666 |
| ERROR_REASON | String | TOTAL_MINUTES_OVER_THRESHOLD |
| LINK | HTTP URL | https://admin.webex.com/diagnostic/loadingDetail/123456785259637816 |
| ORGANIZATION_NAME | String | Example Org |
| participant_email_hash (internal-only field) | String | e400357589e00fae729b089aede2a06e1c279bb200b6028d8cdb8eaef811ed59 |
| reference_id_hash (internal-only field) | String | e400357589e00fae729b089aede2a06e1c279bb200b6028d8cdb8eaef811ed59 |
| report_audioMainReport_rxE2eLostPercent | Percent | 7% |
| report_audioMainReport_rxE2eLostPercent__threshold | Percent | 5% |
| report_audioMainReport_rxE2eLostPercent__timestamp1_utc | ISO timestamp | Tue, 18 Jun 2024 08:07:50 UTC |
| report_audioMainReport_rxE2eLostPercent__timestamp2_utc | ISO timestamp | Tue, 18 Jun 2024 08:07:50 UTC |
| report_audioMainReport_transportType | String | UDP |
| report_intervalMetadata_serverRegion | String | United States |
User as a target with monitoring all participants enabled for the alert
| Field | Data type | Example |
|---|---|---|
| CONERFERENCE_ID | Long | 111222333444555666 |
| ERROR_REASON | String | TOTAL_MINUTES_OVER_THRESHOLD |
| LINK | HTTP URL | https://admin.webex.com/diagnostic/loadingDetail/296152875259637816 |
| ORGANIZATION_NAME | String | Example Org |
| report_audioMainReport_meanRoundTripTime | ISO timestamp | Tue, 18 Jun 2024 08:07:50 UTC |
| report_audioMainReport_meanRoundTripTime__threshold | Integer | 800 |
| report_audioMainReport_meanRoundTripTime__timestamp1_utc | ISO timestamp | Tue, 18 Jun 2024 08:07:50 UTC |
| report_audioMainReport_meanRoundTripTime__timestamp2_utc | ISO timestamp | Tue, 18 Jun 2024 08:07:50 UTC |
| report_audioMainReport_transportType | String | UDP |
| report_intervalMetadata_serverRegion | String | United States |
Historical meeting quality monitoring alert
| Field | Data type | Example |
|---|---|---|
| ALERT_ID | UUID | 47c89fe6-2944-4552-9576-02c571a9555e |
| END_DATE | Date | 2024-07-16 |
| ERROR_REASON | String | CALLS_OVER_THRESHOLD |
| ERROR_VALUE | Percent | 10.9% |
| LINK | HTTP URL | https://admin.webex.com/diagnostic/loadingDetail/296152875259637816 |
| ORGANIZATION_NAME | String | Example Org |
| SITE_NAME | String | example.webex.com |
| START_DATE | Date | 2024-06-16 |
Historical meeting quality trend
| Field | Data type | Example |
|---|---|---|
| ALERT_ID | UUID | 47c89fe6-2944-4552-9576-02c571a9555e |
| END_DATE | Date | 2024-07-16 |
| ERROR_REASON | String | CALLS_OVER_THRESHOLD |
| ERROR_VALUE | Percent | 10.9% |
| LINK | HTTP URL | https://admin.webex.com/diagnostic/loadingDetail/296152875259637816 |
| NO_OF_CALLS_THRESHOLD | Integer | 10 |
| ORGANIZATION_NAME | String | Example Org |
| PACKET_LOSS_LAST_DAY_MINS | Number | 5 |
| PACKET_LOSS_LAST_DAY_PET | Percent | 20% |
| PACKET_LOSS_LAST_WEEK_MINS | Number | 5 |
| PACKET_LOSS_LAST_WEEK_PCT | Percent | 20% |
| SITE_NAME | String | example.webex.com |
| START_DATE | Date | 2024-06-16 |
| THRESHOLD_PERCENTAGE | Percent | 15% |
Cisco devices webhook field reference
For information on webhook field references for Cisco devices, see this article.
