List Webhooks
List all of your webhooks.
Query Parameters
Limit the maximum number of webhooks in the response.
Limit the result list to org wide webhooks. Only allowed value is org.
Response Properties
A unique identifier for the webhook.
A user-friendly name for the webhook.
URL that receives POST requests for each event.
Resource type for the webhook. Creating a webhook requires 'read' scope on the resource the webhook is for.
Attachment Actions resource.
Memberships resource.
Messages resource.
Rooms resource.
Meetings resource.
Recordings resource.
CallRecordings resource.
Meeting Participants resource.
Meeting Transcripts resource.
Performance counter for a dedicated instance.
Service App authorization notification.
Admin Batch Jobs notification.
Event type for the webhook.
An object was created.
An object was updated.
An object was deleted.
A meeting was started.
A meeting was ended.
A participant joined.
A participant left.
A room was migrated to a different geography. The roomId has changed.
A Service App was authorized.
A Service App was deauthorized.
Status of admin batch job was changed.
Filter that defines the webhook scope.
Secret used to generate payload signature.
Status of the webhook. Use active to reactivate a disabled webhook.
Webhook is active.
Webhook is inactive.
Date and time the webhook was created.
Specify org when creating an org/admin level webhook. Supported for meetings, recordings, convergedRecordings, meetingParticipants, meetingTranscripts, videoMeshAlerts, controlHubAlerts, rooms, messaging and adminBatchJobs (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.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The 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. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The 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. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The 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. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too 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. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Limit the maximum number of webhooks in the response.
- Limit the result list to org wide webhooks. Only allowed value is `org`.
{
"items": [
{
"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"
}
]
}