v2

latestOpenAPI 3.0.4Commercial License2026-08-0718678294.5 KB
Webhooks

List webhook endpoints

Get all configured webhook endpoints for the authenticated user. Requires the Scale plan.

get/v1/webhooks

Response

List of webhook endpoints

successboolean

Example response

{
  "success": true,
  "webhooks": [
    {
      "id": "wh_1a2b3c4d5e6f",
      "url": "https://api.yourcompany.com/webhooks/oilpriceapi",
      "events": [
        "price.updated",
        "drilling.rig_count.updated"
      ],
      "secret": "whsec_1234567890abcdef",
      "active": true,
      "created_at": "2025-08-10T10:30:00Z",
      "updated_at": "2025-08-10T10:30:00Z",
      "last_delivery": {
        "attempted_at": "2025-08-10T12:00:00Z",
        "status": "success",
        "response_code": 200
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 100,
    "total_pages": 5,
    "total_count": 450,
    "next_page": 2
  }
}