v1

latestOpenAPI 3.1.02026-08-042453938.9 KB
Webhooks

List webhooks

Get all webhooks for your business with delivery statistics. Requires a secret key (sk_). Public keys (pk_) will receive a 403 error.

get/v1/webhooks

Response

List of webhooks

countinteger

Total webhooks

Example response

{
  "data": [
    {
      "id": "whk_abc123def456",
      "url": "https://api.example.com/webhooks/drip",
      "events": [
        "charge.succeeded",
        "charge.failed"
      ],
      "description": "Production billing events",
      "isActive": true,
      "healthStatus": "HEALTHY",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "stats": {
        "total": 1250,
        "delivered": 1245,
        "failed": 3,
        "pending": 2
      }
    }
  ],
  "count": 2
}