List Webhooks

Retrieves webhooks for the authenticated team (paginated). Results are capped at limit (default and maximum 1000). When more records exist than are returned, meta.total exceeds data.length; clients with large collections must page with limit/offset to retrieve them all.

GET /api/v2/webhooks

Error

A valid request URL is required to generate request examples

200

{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Production Alerts",
      "service": "slack",
      "updatedAt": "2025-06-15T10:30:00.000Z",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
      "description": "Sends critical alerts to the #incidents channel"
    }
  ],
  "meta": {
    "total": 142,
    "limit": 50,
    "offset": 100
  }
}

{
  "message": "Unauthorized access. API key is missing or invalid."
}

{
  "message": "NOT_FOUND: Alert not found"
}

인증

Authorization · string · header · 필수

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

쿼리 매개변수

limit · integer · 기본값: 1000

Maximum number of webhooks to return.

필수 범위: 1 <= x <= 1000

offset · integer · 기본값: 0

Number of webhooks to skip before returning results.

필수 범위: x >= 0

응답

200

application/json

Successfully retrieved webhooks

data · object[] · 필수

List of webhook objects.

Option 1

Option 2

Option 3

Show child attributes

meta · object · 필수

Pagination metadata for this result page.

Show child attributes