Platform Introduction Bots Integrations Widgets Guest Issuer

Getting Started Basics

Admin API Buttons and Cards Compliance Hybrid Services Webhooks xAPI

Admin Audit Events Attachment Actions Devices Events Hybrid Clusters Hybrid Connectors Licenses Memberships Messages Organizations People Places Resource Group Memberships Resource Groups Roles Rooms Team Memberships Teams
Webhooks
GET List WebhooksPOST Create a WebhookGET Get Webhook DetailsPUT Update a WebhookDELETE Delete a Webhook
xAPI
API Changelog

iOS Android Browser Node.js Java Community

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.

event
enumrequired

The event type for the webhook.

filter
string

The filter that defines the webhook scope.

secret
string

The secret used to generate payload signature.

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.

memberships

the Memberships resource

messages

the Messages resource

rooms

the Rooms resource

event
enum

The event type for the webhook.

created

an object was created

updated

an object was updated

deleted

an object was deleted

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

the webhook is active

inactive

the webhook is inactive

created
string

The date and time the webhook was created.

Response Codes

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

CodeStatusDescription
200OKSuccessful request with body content.
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.
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.
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.
  • The secret used to generate payload signature.
{
  "name": "My Awesome Webhook",
  "targetUrl": "https://example.com/mywebhook",
  "resource": null,
  "event": null,
  "filter": "roomId=Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
  "secret": "86dacc007724d8ea666f88fc77d918dad9537a15"
}
{
  "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"
}