Update Endpoint

Version: v1

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

Path Parameters

id string required

ID of the endpoint that is returned by the Create Endpoint or the List Endpoints API.

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.

Responses

200

A successful response.

Schema

Example

Schema

id string optional

A unique ID for the endpoint

created date-time optional

The time when the endpoint was created

modified date-time optional

The time when the endpoint was last modified

enabled boolean optional

Whether or not this endpoint is active

url string optional

The destination URL of this endpoint

event_types object[] optional

A list of the event types that are currently configured to be sent to this endpoint

Array [

event_name string optional

subcategory string optional

]

{
  "id": "aHR0cHM6Ly9leGFtcGxlLmNvbS9mdWxsc3Rvcnktd2ViaG9va3M",
  "created": "2020-04-01T21:53:58.200Z",
  "modified": "2020-04-01T21:53:58.200Z",
  "enabled": true,
  "url": "https://example.com/fullstory-webhooks",
  "eventTypes": [
    {
      "eventName": "recording.event.custom",
      "subcategory": "CgsiCW8tSDkxLW5hMRIOCgRTZWF0GgZzeXN0ZW0SEwoHU2VnbWVudBoIZXZlcnlvbmUSEQoIU2VhcmNoaWUaBTQ5MTY4EhAKBUFsZXJ0EICAgICAqJkL"
    }
  ]
}

Returned when invalid input has been provided. Fix the issue and retry.

Schema

Example

{
  "message": "uid is required",
  "code": "required_field"
}

Returned when access to the resource is unauthorized.

Schema

Example

{
  "message": "access is unauthorized",
  "code": "unauthorized"
}

Returned when access is not allowed due to insufficient permissions.

Schema

Example

{
  "message": "insufficient permissions",
  "code": "forbidden"
}

Returned when the resource does not exist.

Schema

Example

{
  "message": "Requested resource does not exist",
  "code": "resource_not_found"
}

Returned when the client has exceeded the rate limit for this endpoint.

Schema

Example

{
  "message": "Too many requests. Client has exceeded the rate limit for this endpoint.",
  "code": "too_many_requests"
}

Returned when a server error is encountered

Schema

Example

{
  "message": "Server error was encountered",
  "code": "server_error"
}

Update Endpoint​

Update Endpoint