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 webhoooks.

1

From the customer view in https://admin.webex.com, go to Organization settings.

2

Scroll to the Alerts section.

3

Under Webhook callback URL, add the URL that you want to use.

You can also choose to add a secure token for the webhook. View this blog to learn more about secure tokens.

An alert optionfor webhook call back URLs
4

Click 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 nameData typeExample
CONFERENCE_IDLong111222333444555666
DEVICE_URLHTTP URL pair
  • https://csdm-a.wbx2.com/csdm/api/v1/organization/12ab345c-a800-4c83-96b1-5c3d72bcecdf/devices/a123b456-f0dc-56fb-a7c1-a368ebc37f17
  • https:///wdm-a.wbx2.com/wdm/api/v1/devices/1234c841
ERROR_REASONStringBOTH_OVER_THRESHOLD
LINKHTTP URLhttps://admin.webex.com/diagnostic/loadingDetail/123456789012345678
ORGANIZATION_NAMEStringExample Org
REFERENCE_IDStringSGDAC_05-Meeting Pod 19
participant_deviceUrlHTTP URL pair
  • https://csdm-a.wbx2.com/csdm/api/v1/organization/12ab345c-a800-4c83-96b1-5c3d72bcecdf/devices/a123b456-f0dc-56fb-a7c1-a368ebc37f17
  • https:///wdm-a.wbx2.com/wdm/api/v1/devices/1234c841
report_audioMainReport_rxE2eLostPercent__thresholdPercent8%
report_audioMainReport_rxE2eLostPercent__timestamp1_utcISO timestampTue, 18 Jun 2024 08:07:50 UTC
report_audioMainReport_rxE2eLostPercent__timestamp2_utcISO timestampTue, 18 Jun 2024 08:07:50 UTC
report_audioMainReport_transportTypeStringUDP
report_intervalMetadata_serverRegionStringUnited States
report_audioMainReport_rxE2eLostPercentPercent16%

User as a target for the alert

FieldData typeExample
CONFERENCE_IDLong111222333444555666
ERROR_REASONStringTOTAL_MINUTES_OVER_THRESHOLD
LINKHTTP URLhttps://admin.webex.com/diagnostic/loadingDetail/123456785259637816
ORGANIZATION_NAMEStringExample Org
participant_email_hash (internal-only field)Stringe400357589e00fae729b089aede2a06e1c279bb200b6028d8cdb8eaef811ed59
reference_id_hash (internal-only field)Stringe400357589e00fae729b089aede2a06e1c279bb200b6028d8cdb8eaef811ed59
report_audioMainReport_rxE2eLostPercentPercent7%
report_audioMainReport_rxE2eLostPercent__thresholdPercent5%
report_audioMainReport_rxE2eLostPercent__timestamp1_utcISO timestampTue, 18 Jun 2024 08:07:50 UTC
report_audioMainReport_rxE2eLostPercent__timestamp2_utcISO timestampTue, 18 Jun 2024 08:07:50 UTC
report_audioMainReport_transportTypeStringUDP
report_intervalMetadata_serverRegionStringUnited States

User as a target with monitoring all participants enabled for the alert

FieldData typeExample
CONERFERENCE_IDLong111222333444555666
ERROR_REASONStringTOTAL_MINUTES_OVER_THRESHOLD
LINKHTTP URLhttps://admin.webex.com/diagnostic/loadingDetail/296152875259637816
ORGANIZATION_NAMEStringExample Org
report_audioMainReport_meanRoundTripTimeISO timestampTue, 18 Jun 2024 08:07:50 UTC
report_audioMainReport_meanRoundTripTime__thresholdInteger800
report_audioMainReport_meanRoundTripTime__timestamp1_utcISO timestampTue, 18 Jun 2024 08:07:50 UTC
report_audioMainReport_meanRoundTripTime__timestamp2_utcISO timestampTue, 18 Jun 2024 08:07:50 UTC
report_audioMainReport_transportTypeStringUDP
report_intervalMetadata_serverRegionStringUnited States

Historical meeting quality monitoring alert

FieldData typeExample
ALERT_IDUUID47c89fe6-2944-4552-9576-02c571a9555e
END_DATEDate2024-07-16
ERROR_REASONStringCALLS_OVER_THRESHOLD
ERROR_VALUEPercent10.9%
LINKHTTP URLhttps://admin.webex.com/diagnostic/loadingDetail/296152875259637816
ORGANIZATION_NAMEStringExample Org
SITE_NAMEStringexample.webex.com
START_DATEDate2024-06-16

Historical meeting quality trend

FieldData typeExample
ALERT_IDUUID47c89fe6-2944-4552-9576-02c571a9555e
END_DATEDate2024-07-16
ERROR_REASONStringCALLS_OVER_THRESHOLD
ERROR_VALUEPercent10.9%
LINKHTTP URLhttps://admin.webex.com/diagnostic/loadingDetail/296152875259637816
NO_OF_CALLS_THRESHOLDInteger10
ORGANIZATION_NAMEStringExample Org
PACKET_LOSS_LAST_DAY_MINSNumber5
PACKET_LOSS_LAST_DAY_PETPercent20%
PACKET_LOSS_LAST_WEEK_MINSNumber5
PACKET_LOSS_LAST_WEEK_PCTPercent20%
SITE_NAMEStringexample.webex.com
START_DATEDate2024-06-16
THRESHOLD_PERCENTAGEPercent15%

Cisco devices webhook field reference

For information on webhook field references for Cisco devices, see this article.