DocumentationBlogSupport
Log inSign up
Log inSign up
BlogSupport
Build
Getting StartedPlatform Introduction
Embedded Apps
OverviewDeveloper GuideSidebar API Quick StartSubmission Checklist for Embedded Apps
Design Guidelines
MessagingMeetingsDevicesSidebar
API Reference
BotsButtons and CardsIntegrationsService AppsLogin with WebexGuest IssuerWidgetsWebex ConnectInstant Connect Meeting LinksDeveloper SandboxSubmit Your AppSupport PolicyFAQs
APIs
XML API DeprecationAccess the APIREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Hybrid ServicesWebhooks
Real-time File DLP BasicsUsing Webex Service AppsProvisioning APIsAudit Events Error Reference
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesMeeting QualitiesOrganization ContactsOrganizationsPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSecurity Audit EventsSession TypesSpace ClassificationsTracking CodesWorkspace LocationsWorkspace Metrics
Webex Calling Beta
Overview
Guides
Integrations and Authorization
Webex Calling
OverviewSDKs and ToolsWhat's New
Guides
Integrations and AuthorizationProvisioning APIsWebex for Wholesale
Reference
Call ControlsCall RoutingCalling Service SettingsDevice Call SettingsDevicesFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupFeatures: Receptionist ClientLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsNumbersPeopleRecording ReportReportsReports: Detailed Call HistoryUser Call SettingsVirtual Line Call SettingsWholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspaces
Webex for Broadworks
Overview
Guides
Integrations and AuthorizationWholesale and Broadworks Common GuideDeveloper's Guide
Reference
BroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks Workspaces
Webex for UCM
Guides
Integrations and Authorization
Reference
UCM Profile
Contact Center
Overview
Customer Journey Data
Overview
Guides
Getting StartedFAQ
Devices
Overview
Guides
Devices
Reference
Device Call SettingsDevice ConfigurationsDevicesWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
Meetings
Overview
Guides
Integrations and AuthorizationWebhooks
Using Webex Service AppsWebinar GuideMeeting Resource Guide
Reference
Meeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportPeopleRecording ReportRecordingsSession TypesTracking CodesVideo MeshWebhooks
GETList Webhooks
POSTCreate a Webhook
GETGet Webhook Details
PUTUpdate a Webhook
DELETEDelete a Webhook
Messaging
Overview
Guides
BotsIntegrations and AuthorizationWebhooks
Using Webex Service AppsButtons and Cards
Reference
Attachment ActionsEventsMembershipsMessagesPeopleRoom TabsRoomsTeam MembershipsTeamsTracking CodesWebhooks
GETList Webhooks
POSTCreate a Webhook
GETGet Webhook Details
PUTUpdate a Webhook
DELETEDelete a Webhook
Webex Assistant Skills
Overview
Guides
Skills SDK GuideSkills Developer PortalSkills Reference GuideSkills UX Guide
FedRAMP
Overview
Guides
Create a BotCreate an IntegrationNotes on API Support
Workspace Integrations
OverviewTechnical DetailsControl Hub Features
Webex Status API
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Billing ReportsBroadWorks EnterprisesBroadWorks SubscribersBroadWorks WorkspacesCall ControlsCall RoutingCalling Service SettingsDevice Call SettingsDevice ConfigurationsDevicesEventsFeatures: Announcement RepositoryFeatures: Auto AttendantFeatures: Call ParkFeatures: Call PickupFeatures: Call QueueFeatures: Call RecordingFeatures: Hunt GroupFeatures: Paging GroupFeatures: Receptionist ClientGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocation Call SettingsLocation Call Settings: Call HandlingLocation Call Settings: SchedulesLocation Call Settings: VoicemailLocationsMeeting ChatsMeeting Closed CaptionsMeeting InviteesMeeting MessagesMeeting ParticipantsMeeting PollsMeeting PreferencesMeeting Q and AMeeting QualitiesMeeting TranscriptsMeetingsMeetings Summary ReportMembershipsMessagesNumbersOrganization ContactsOrganizationsPartner ManagementPartner TagsPeopleRecording ReportRecordingsReport TemplatesReportsReports: Detailed Call HistoryResource Group MembershipsResource GroupsRolesRoom TabsRoomsSecurity Audit EventsSession TypesSiteSpace ClassificationsTeam MembershipsTeamsTracking CodesUCM ProfileUser Call SettingsVideo MeshVirtual Line Call SettingsWebhooks
GETList Webhooks
POSTCreate a Webhook
GETGet Webhook Details
PUTUpdate a Webhook
DELETEDelete a Webhook
Wholesale Billing ReportsWholesale ProvisioningWorkspace Call SettingsWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog
SDKs
iOSAndroidBrowserNode.jsJava
Developer CommunityCertifications

Create a Webhook

Creates a webhook.

To learn more about how to create and use webhooks, see The Webhooks Guide.

POST/v1/webhooks
Body Parameters
name
stringrequired

A user-friendly name for the webhook.

targetUrl
stringrequired

The URL that receives POST requests for each event.

resource
enumrequired

The resource type for the webhook. Creating a webhook requires 'read' scope on the resource the webhook is for.

attachmentActions
string

The Attachment Actions resource.

memberships
string

The Memberships resource.

messages
string

The Messages resource.

rooms
string

The Rooms resource.

meetings
string

The Meetings resource.

recordings
string

The Recordings resource.

meetingParticipants
string

The Meeting Participants resource.

meetingTranscripts
string

The Meeting Transcripts resource.

event
enumrequired

The event type for the webhook.

created
string

An object is created.

updated
string

An object is updated.

deleted
string

An object is deleted.

started
string

A meeting is started.

ended
string

A meeting is ended.

joined
string

A participant joined.

left
string

A participant left.

migrated
string

A room was migrated to a different geography. The roomId has changed.

filter
string

The filter that defines the webhook scope. See Filtering Webhooks for more information.

secret
string

The secret used to generate payload signature.

ownedBy
string

Specify org when creating an org/admin level webhook. Supported for meetings, recordings, meetingParticipants, meetingTranscripts, videoMeshAlerts, controlHubAlerts, rooms, and messaging (for Compliance Officers and messages with file attachments only - see inline file DLP) resources.

Response Properties
id
string

A unique identifier for the webhook.

name
string

A user-friendly name for the webhook.

targetUrl
string

The URL that receives POST requests for each event.

resource
enum

The resource type for the webhook. Creating a webhook requires 'read' scope on the resource the webhook is for.

attachmentActions
string

The Attachment Actions resource.

memberships
string

The Memberships resource.

messages
string

The Messages resource.

rooms
string

The Rooms resource.

meetings
string

The Meetings resource.

recordings
string

The Recordings resource.

meetingParticipants
string

The Meeting Participants resource.

meetingTranscripts
string

The Meeting Transcripts resource.

event
enum

The event type for the webhook.

created
string

An object was created.

updated
string

An object was updated.

deleted
string

An object was deleted.

started
string

A meeting was started.

ended
string

A meeting was ended.

joined
string

A participant joined.

left
string

A participant left.

migrated
string

A room was migrated to a different geography. The roomId has changed.

filter
string

The filter that defines the webhook scope.

secret
string

The secret used to generate payload signature.

status
enum

The status of the webhook. Use active to reactivate a disabled webhook.

active
string

The webhook is active.

inactive
string

The webhook is inactive.

created
string

The date and time the webhook was created.

ownedBy
string

Specify org when creating an org/admin level webhook. Supported for meetings, recordings, meetingParticipants, meetingTranscripts, videoMeshAlerts, controlHubAlerts, rooms, and messaging (for Compliance Officers and messages with file attachments only - see inline file DLP) resources.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
201CreatedThe request has succeeded and has led to the creation of a resource.
202AcceptedThe request has been accepted for processing.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
  • Try it
  • Example
POST
/v1/webhooks
Log in to try the API.
Header
Body
  • A user-friendly name for the webhook.
  • The URL that receives POST requests for each event.
  • The resource type for the webhook. Creating a webhook requires 'read' scope on the resource the webhook is for.
  • The event type for the webhook.
  • The filter that defines the webhook scope. See [Filtering Webhooks](/docs/api/guides/webhooks#filtering-webhooks) for more information.
  • The secret used to generate payload signature.
  • Specify `org` when creating an org/admin level webhook. Supported for `meetings`, `recordings`, `meetingParticipants`, `meetingTranscripts`, `videoMeshAlerts`, `controlHubAlerts`, `rooms`, and `messaging` (for Compliance Officers and messages with file attachments only - see [inline file DLP](https://developer.webex.com/docs/api/guides/webex-real-time-file-dlp-basics)) resources.
  • Request
  • Response
{
  "name": "My Awesome Webhook",
  "targetUrl": "https://example.com/mywebhook",
  "resource": "messages",
  "event": "created",
  "filter": "roomId=Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
  "secret": "86dacc007724d8ea666f88fc77d918dad9537a15",
  "ownedBy": "org"
}
200 / OK
{
  "id": "Y2lzY29zcGFyazovL3VzL1dFQkhPT0svOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
  "name": "My Awesome Webhook",
  "targetUrl": "https://example.com/mywebhook",
  "resource": "messages",
  "event": "created",
  "filter": "roomId=Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
  "secret": "86dacc007724d8ea666f88fc77d918dad9537a15",
  "status": "active",
  "created": "2015-10-18T14:26:16+00:00",
  "ownedBy": "org"
}

Connect

Support

Developer Community

Developer Events

Contact Sales

Handy Links

Webex Ambassadors

Webex App Hub

Resources

Open Source Bot Starter Kits

Download Webex

DevNet Learning Labs

Terms of Service

Privacy Policy

Cookie Policy

Trademarks

© 2023 Cisco and/or its affiliates. All rights reserved.