---
title: "List Webhooks"
method: POST
path: "/v1/organizations/webhooks/list"
tags: ["Webhooks"]
---

# List Webhooks

`POST /v1/organizations/webhooks/list`

List all webhooks for the user's organization.

## Query parameters

- `limit` integer, nullable
- `page_size` integer, nullable
- `offset` integer, nullable
- `page` integer, nullable
- `cursor` string, nullable
- `next_cursor` string, nullable
- `after` string, nullable
- `include_total` boolean

## Request body

- ListWebhooksRequest — Request for listing webhooks with filters. Filters webhooks by various criteria.
  - `event_type` string, nullable — Filter by event type
  - `is_active` boolean, nullable — Filter by active status

## Response `200`

Successful Response

- ListWebhooksResponse — Response for listing webhooks with pagination. Returns a paginated list of webhook records.
  - `results` WebhookOutput[], required — List of webhooks
    - `webhook_id` string — Unique identifier for the webhook. Auto-generated with 'wh_' prefix followed by secure random token. Format: wh_{16-character hex}. Used for API operations and event tracking.
    - `webhook_name` string, required — REQUIRED. Human-readable name for the webhook. Displayed in dashboards, logs, and notification metadata. Should describe the webhook's purpose or destination. Format: 1-200 characters.
    - `event_types` WebhookEventType[], required — REQUIRED. List of event types that trigger this webhook. When any of these events occur, notifications are sent to all channels. Must contain at least one event type. Common patterns: - ['object.created', 'object.updated'] for object lifecycle tracking - ['cluster.execution.completed', 'cluster.execution.failed'] for job monitoring - ['*'] for all events (use cautiously, high volume)
    - `channels` WebhookChannelOutput[], required — REQUIRED. List of notification channels for event delivery. When an event occurs, notifications are sent to ALL configured channels. Must contain at least one channel. Multiple channels provide redundancy and multi-audience delivery. Example: Send to both Slack (team) and email (manager) for critical events.
      - `channel` 'email' | 'slack' | 'webhook', required — Enum for notification delivery channels.
      - `configs` union, required — REQUIRED. Channel-specific configuration for notification delivery. Type depends on the channel field: - EmailConfig for EMAIL channel (recipients, subject template, etc.) - SlackConfig for SLACK channel (workspace, channel, bot token) - WebhookConfig for WEBHOOK channel (URL, headers, auth). See respective config models for detailed field requirements.
        - SharedNotificationsVendorsEmailModelsEmailConfig — Configuration for email notifications.
          - `to_addresses` string[], required — Email addresses to send to
          - `subject_template` string, nullable — Template for email subject
          - `body_template` string, nullable — Template for email body
          - `content_type` 'plain_text' | 'html' | 'markdown' | 'json' — Enum for content formats.
          - `cc_addresses` string[] — CC addresses
          - `bcc_addresses` string[] — BCC addresses
        - SlackConfig — Configuration for Slack notifications.
          - `webhook_url` string, required — Slack webhook URL
          - `channel` string, nullable — Slack channel to send to
          - `username` string, nullable — Username to use for the message
          - `icon_emoji` string, nullable — Emoji to use as the icon
          - `icon_url` string, nullable — URL to an image to use as the icon
          - `blocks_template` string, nullable — Template for Slack blocks
        - WebhookConfig — Configuration for webhook notifications.
          - `url` string, required — The URL to which the webhook will be sent.
          - `headers` object — Custom headers to include in the webhook request.
          - `payload_template` object, nullable — A Jinja2 template for the JSON payload.
          - `timeout` number — Request timeout in seconds.
    - `is_active` boolean — Whether the webhook is currently active and should send notifications. True: Events trigger notifications to channels. False: Webhook is paused, no notifications sent but config preserved. Use to temporarily disable webhooks without losing configuration. Default: True
    - `created_at` string, date-time — UTC timestamp when the webhook was created. Auto-generated at creation time. Immutable after creation. Format: ISO 8601 datetime.
    - `updated_at` string, date-time — UTC timestamp of the most recent webhook update. Updated automatically when event_types, channels, or is_active changes. Tracks configuration modifications. Format: ISO 8601 datetime.
  - `pagination` PaginationResponse, required — PaginationResponse. Cursor-based pagination response: - Use next_cursor for navigation - Total count fields only populated when include_total=true
    - `total` integer, nullable
    - `page` integer, nullable
    - `page_size` integer, nullable
    - `total_pages` integer, nullable
    - `next_page` string, nullable
    - `previous_page` string, nullable
    - `next_cursor` string, nullable
  - `total` integer, required — Total number of webhooks

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Validation Error
- `500` — Internal Server Error

---

[API](https://skmtc.net/mixpeek/apis/mixpeek-api.md) · [All operations](https://skmtc.net/mixpeek/apis/mixpeek-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mixpeek/mixpeek-api/revisions/1c7f31821424/schema)