GET
/
v1
/
organizations
/
webhooks
/
List Webhooks
curl --request GET \
  --url https://api.mixpeek.com/v1/organizations/webhooks/
[
  {
    "webhook_id": "<string>",
    "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>"
          ]
        }
      }
    ],
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Headers

​
Authorization
string | null

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. Example: 'Bearer sk_1234567890abcdef'

Response

Successful Response

​
webhook_name
string
required

Human-readable name for the webhook.

​
event_types
enum<string>[]
required

A list of event types that this webhook subscribes to.

​
channels
WebhookChannel · object[]
required

A list of channels to notify for the subscribed events.

​
webhook_id
string

Unique identifier for the webhook.

​
is_active
boolean
default:true

Whether the webhook is currently active and should send notifications.

​
created_at
string<date-time>

Timestamp of when the webhook was created.

​
updated_at
string<date-time>

Timestamp of the last update.