Skip to main content
Version: v1

Update Endpoint

This API can be used to change the destination URL, configured events, signing secret, and the enabled status of the webhook endpoint.

Path Parameters
Request Body required
    disabled boolean optional

    If present and true, the given endpoint will be disabled and stop receiving events. Otherwise, the given endpoint will be enabled.

    event_types object[] optional

    The new set of event types that the endpoint should receive. If absent or an empty list, the set of events will not be changed.

  • Array [
  • event_name string optional

    The name of an event. There is a fixed set of supported event names, each representing a different kind of event that can be sent to a webhook endpoint. This is the same value that is sent to a webhook endpoint, in the "eventName" field of the request payload.

    subcategory string optional

    Optional subcategory. Some event types require further specifying a subcategory. For example, the "recording.event.custom" event requires specifying a particular custom event as the subcategory. This field will be empty for kinds of events that do not require a subcategory. When specified, this needs to be the subcategory returned from List Event Subcategories and not the display_name.

  • ]
  • url string optional

    The new URL for the endpoint. Note that changing the URL also changes the ID of the endpoint. See the id property in the response for the endpoint's new ID. If absent or an empty string, the URL will not be changed.

    secret string optional

    The new secret for the endpoint used for signing payloads. If absent or an empty string, the secret will not be changed.


A successful response.

"id": "aHR0cHM6Ly9leGFtcGxlLmNvbS9mdWxsc3Rvcnktd2ViaG9va3M",
"created": "2020-04-01T21:53:58.200Z",
"modified": "2020-04-01T21:53:58.200Z",
"enabled": true,
"url": "",
"eventTypes": [
"eventName": "recording.event.custom",