API Reference

List all endpoints for the authenticated account.

[
  {
    "id": "ep_abc123",
    "url": "https://myapp.com/webhook",
    "description": "Order notifications",
    "is_active": true,
    "created_at": "2026-01-15T10:30:00Z"
  }
]

Create a new endpoint.

{
  "url": "https://myapp.com/webhook",
  "description": "Order notifications"  // optional
}

{
  "id": "ep_abc123",
  "url": "https://myapp.com/webhook",
  "description": "Order notifications",
  "signing_secret": "whsec_abc123xyz789...",
  "is_active": true,
  "created_at": "2026-01-15T10:30:00Z"
}

Delete an endpoint. All pending deliveries to this endpoint will be cancelled.

{ "deleted": true }

Send a webhook to an endpoint.

{
  "endpoint_id": "ep_abc123",
  "event": "order.created",       // optional
  "data": {                        // your payload
    "order_id": "12345",
    "total": 99.99
  }
}

{
  "id": "wh_xyz789",
  "endpoint_id": "ep_abc123",
  "event": "order.created",
  "status": "pending",
  "attempt_count": 0,
  "created_at": "2026-01-15T10:30:00Z"
}

List webhook deliveries with optional filtering and pagination.

// Query Parameters:
// ?page=1          — page number
// ?per_page=20     — results per page
// ?status=delivered — filter by status
// ?event=order.created — filter by event type

{
  "deliveries": [
    {
      "id": "wh_xyz789",
      "endpoint_id": "ep_abc123",
      "event": "order.created",
      "status": "delivered",
      "attempt_count": 1,
      "response_status": 200,
      "created_at": "2026-01-15T10:30:00Z"
    }
  ],
  "total": 142,
  "page": 1,
  "per_page": 20
}

Get details of a specific webhook delivery including attempt history.

{
  "id": "wh_xyz789",
  "endpoint_id": "ep_abc123",
  "event": "order.created",
  "status": "delivered",
  "attempt_count": 2,
  "response_status": 200,
  "attempts": [
    { "attempt": 1, "status": 500, "timestamp": "2026-01-15T10:30:00Z" },
    { "attempt": 2, "status": 200, "timestamp": "2026-01-15T10:35:00Z" }
  ],
  "created_at": "2026-01-15T10:30:00Z"
}

Get aggregate delivery statistics for the authenticated account.

{
  "total_deliveries": 12847,
  "delivered": 12453,
  "failed": 127,
  "pending": 267,
  "success_rate": 96.93,
  "endpoints_count": 8
}