---
title: "List webhook endpoints"
method: GET
path: "/webhook_endpoints"
tags: ["Webhook endpoints"]
---

# List webhook endpoints

`GET /webhook_endpoints`

## Request

- Base URL: `https://www.happyscribe.com/api/v1`
- URL: `https://www.happyscribe.com/api/v1/webhook_endpoints`
- Auth: API key in header `Authorization`

The webhook endpoints of the workspaces the key administers, oldest first, including the
ones added in **Settings → Webhooks**. The signing secret is never listed.

## Query parameters

- `workspace_id` string
- `limit` integer
- `cursor` string

## Response `200`

One page of webhook endpoints.

- WebhookEndpointList
  - `object` string: Always `list`.
  - `data` WebhookEndpoint[]: The webhook endpoints on this page.
    - `id` string: Webhook endpoint ID, beginning with `whe_`. Treat it as an opaque string.
    - `object` string: Always `webhook_endpoint`.
    - `workspace_id` string: Workspace ID, beginning with `wks_`. Treat it as an opaque string.
    - `name` string: Defaults to the URL's host.
    - `url` string, uri: The public HTTPS URL events are sent to.
    - `enabled_events` string[]: The events it receives, named as its `api_version` names them. `*` is every event.
    - `status` 'enabled' | 'disabled': Whether it receives events. - `enabled`: receives events. - `disabled`: receives nothing; disabling cancels its pending deliveries.
    - `api_version` string, date: The version its events are named and shaped at.
    - `metadata` Metadata: Your own key-value pairs, for your ids and context. HappyScribe stores them, returns them on the object and in every webhook that carries it, and never acts on them. Up to 50 keys of up to 40 characters (no square brackets), values up to 500 characters. See [metadata](/meetingkit/setup#a-workspace-per-customer).
    - `created_at` string, date-time: When it was created, in ISO 8601.
    - `updated_at` string, date-time: When it last changed, in ISO 8601.
  - `has_more` boolean: Whether more results follow this page.
  - `_links` object: Empty on the last page.
    - `next` object: The next page. Absent on the last page.
      - `url` string, uri: The next page, with the same filters.

## Other responses

- `400`: A `limit` or `cursor` that cannot be read.
- `401`: Your API key is missing (`missing_api_key`) or wrong (`invalid_api_key`), or it may not access this resource (`unauthorized`).
- `403`: The key belongs to `workspace_id` but is not an owner or admin of it (`workspace_update_not_allowed`).
- `404`: `workspace_id` is not a workspace the key belongs to.

---

[API](https://skmtc.dev/happyscribe/apis/happyscribe-api.md) - [All operations](https://skmtc.dev/happyscribe/apis/happyscribe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/happyscribe/apis/happyscribe-api/revisions/1281bd968c3d?raw)