Webhooks - List Webhooks | Webex for Developers

List Webhooks

List all of your webhooks.

GET/v1/webhooks

Query Parameters

max

number

Limit the maximum number of webhooks in the response.

Default: 100

ownedBy

string

Limit the result list to org wide webhooks. Only allowed value is org.

Response Properties

items

array[Webhook]

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

Specified when creating an org/admin level webhook.

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.

GET

/v1/webhooks{?max,ownedBy}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

max
number
Limit the maximum number of webhooks in the response.
ownedBy
string
Limit the result list to org wide webhooks. Only allowed value is `org`.

https://webexapis.com/v1/webhooks?max=100&ownedBy=org

200 / OK

{
  "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"
    }
  ]
}