List Endpoints

Version: v1

Page through all of the configured endpoints. If the response contains a nextPaginationToken property, then there are more results which can be retrieved by making another call and using that token as the next request's paginationToken.

Query Parameters

pagination_token string optional

Optional pagination token, for retrieving further results after a previous page request.

limit int32 optional

Optional limit to the number of endpoints returned. If not specified, the max (100) endpoints are returned.

Responses

200

A successful response.

Schema

Example

Schema

endpoints object[] optional

The list of endpoints, up to the limit.

Array [

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

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.

]

next_pagination_token string optional

If present, this pagination token can be supplied in a subsequent request to get the next batch of results. If not present, there are no further results.

{
  "endpoints": [
    {
      "id": "aHR0cDovL2Zvby5iYXIv",
      "created": "2020-03-26T19:16:57.291Z",
      "modified": "2020-04-01T21:46:42.412Z",
      "enabled": true,
      "url": "https://foo.bar/",
      "eventTypes": [
        {
          "eventName": "note.created"
        }
      ]
    }
  ],
  "nextPaginationToken": "aHR0cDovL2Zvby5iYXIv"
}

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"
}

List Endpoints​

List Endpoints