Create a Webhook
Creates a webhook.
To learn more about how to create and use webhooks, see the Webhooks Guide.
Body Parameters
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 Attachment Actions resource
the Memberships resource
the Messages resource
the Rooms resource
The event type for the webhook.
an object is created
an object is updated
an object is deleted
The filter that defines the webhook scope. See Filtering Webhooks for more information.
The secret used to generate payload signature.
Response Properties
A unique identifier for the webhook.
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 Attachment Actions resource
the Memberships resource
the Messages resource
the Rooms resource
The event type for the webhook.
an object was created
an object was updated
an object was deleted
The filter that defines the webhook scope.
The secret used to generate payload signature.
The status of the webhook. Use active to reactivate a disabled webhook.
the webhook is active
the webhook is inactive
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.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 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. |
| 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. |
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.
{
"name": "My Awesome Webhook",
"targetUrl": "https://example.com/mywebhook",
"resource": "messages",
"event": "created",
"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"
}