Create a Webhook

Creates a webhook.

To learn more about how to create and use webhooks, see the Webhooks Explained guide.

You're not logged in. to run the demo.

Request Headers

Content-type application/json; charset=utf-8

Request Parameters

Name Type Description
name string

A user-friendly name for the webhook.

targetUrl string

The URL that receives POST requests for each event.

resource string

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

event string

The event type for the webhook.

filter string

The filter that defines the webhook scope.

secret string

The secret used to generate payload signature.

Request Parameters

Name Type Your values
name string
targetUrl string
resource string
event string
filter string
secret string

Response Codes




The request was invalid or cannot be otherwise served. An accompanying error message will explain further.


Authentication credentials were missing or incorrect.


The request is understood, but it has been refused or access is not allowed.


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.


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.


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.


Something went wrong on the server.


Server is overloaded with requests. Try again later.