Skip to main content
POST
/
v1
/
organizations
/
webhooks
/
list
List Webhooks
curl --request POST \
  --url https://api.mixpeek.com/v1/organizations/webhooks/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "event_type": "<string>",
  "is_active": true
}'
{
  "results": [
    {
      "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"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>"
  },
  "total": 123
}

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"

Query Parameters

​
limit
integer | null
​
offset
integer | null

Body

application/json

Request for listing webhooks with filters.

Filters webhooks by various criteria.

​
event_type
string | null

Filter by event type

​
is_active
boolean | null

Filter by active status

Response

Successful Response

Response for listing webhooks with pagination.

Returns a paginated list of webhook records.

​
results
Webhook · object[]
required

List of webhooks

​
pagination
object
required

Pagination information

​
total
integer
required

Total number of webhooks