Skip to main content
GET
/
v1
/
organizations
/
webhooks
/
List Webhooks
curl --request GET \
  --url https://api.mixpeek.com/v1/organizations/webhooks/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "channels": [
      {
        "channel": "slack",
        "configs": {
          "bot_token": "xoxb-...",
          "channel_id": "C0123456789",
          "workspace_id": "T0123456789"
        }
      }
    ],
    "created_at": "2025-01-01T00:00:00Z",
    "description": "Slack notifications for object lifecycle",
    "event_types": [
      "object.created",
      "object.updated",
      "object.deleted"
    ],
    "is_active": true,
    "updated_at": "2025-01-01T00:00:00Z",
    "webhook_id": "wh_abc123def4",
    "webhook_name": "Engineering Slack Alerts"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings.

Headers

​
Authorization
string
required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer sk_live_abc123def456"

"Bearer sk_test_xyz789"

Response

Successful Response

​
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.

Required string length: 1 - 200
Examples:

"Slack Engineering Alerts"

"External System Integration"

"Audit Trail Logger"

"Production Monitoring"

​
event_types
enum<string>[]
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)

Minimum length: 1
Examples:
[
  "object.created",
  "object.updated",
  "object.deleted"
]
[
  "cluster.execution.completed",
  "cluster.execution.failed"
]
["collection.documents.written"]
​
channels
WebhookChannel · object[]
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.

Minimum length: 1
​
webhook_id
string

Unique identifier for the webhook. Auto-generated with 'wh_' prefix followed by secure random token. Format: wh_{10-character alphanumeric}. Used for API operations and event tracking.

Examples:

"wh_abc123def4"

"wh_xyz789uvw0"

​
is_active
boolean
default:true

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.