Skip to main content
POST
/
v1
/
organizations
/
webhooks
/
list
List Webhooks
curl --request POST \
  --url https://api.mixpeek.com/v1/organizations/webhooks/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_type": "<string>",
  "is_active": true
}
'
{
  "results": [
    {
      "webhook_name": "<string>",
      "event_types": [
        "object.created"
      ],
      "channels": [
        {
          "channel": "email",
          "configs": {
            "to_addresses": [
              "<string>"
            ],
            "subject_template": "<string>",
            "body_template": "<string>",
            "content_type": "html",
            "cc_addresses": [
              "<string>"
            ],
            "bcc_addresses": [
              "<string>"
            ]
          }
        }
      ],
      "webhook_id": "<string>",
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>"
  },
  "total": 123
}

Headers

Authorization
string

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

"Bearer YOUR_STRIPE_API_KEY"

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
PaginationResponse · object
required

Pagination information

total
integer
required

Total number of webhooks