Get webhook health

Derives status (healthy | failing | disabled), success_rate, and last delivery timestamps from the webhook stats counters.

RBAC · webhook

Path parameters

idstring <uuid>Required

Webhook UUID from webhooks.webhook_id.

Response body

Success response 200 · schema WebhookHealthEnvelopeV1

dataobjectRequired

webhook_idstring <uuid>Required

statusstringRequired

Enum: healthyfailingdisabled

is_activebooleanRequired

auto_disabled_atstring <date-time>RequiredNullable

total_deliveriesintegerRequired

successful_deliveriesintegerRequired

failed_deliveriesintegerRequired

success_ratenumberRequired

Fraction in [0,1]; 1 when there are no deliveries yet.

last_delivery_atstring <date-time>RequiredNullable

last_success_atstring <date-time>RequiredNullable

last_failure_atstring <date-time>RequiredNullable

checked_atstring <date-time>Required

metaobject

Response codes

200

Health status returned.

400

Invalid request payload, query, or webhook id format.

401

API key missing/invalid or key user missing.

403

Webhook RBAC permission denied.

404

Webhook, delivery, template, or signing secret not found.

500

Unexpected webhook operation failure.

GET /api/v1/webhooks/{id}/health

cURL

curl -X GET "https://algapsa.com/api/v1/webhooks/{id}/health" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/webhooks/{id}/health", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/webhooks/{id}/health");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {
    "webhook_id": "01HN2K7VRB9PQ3Y0000000000",
    "status": "healthy",
    "is_active": false,
    "auto_disabled_at": "2026-04-18T15:22:14Z",
    "total_deliveries": 1,
    "successful_deliveries": 1,
    "failed_deliveries": 1,
    "success_rate": 0,
    "last_delivery_at": "2026-04-18T15:22:14Z",
    "last_success_at": "2026-04-18T15:22:14Z",
    "last_failure_at": "2026-04-18T15:22:14Z",
    "checked_at": "2026-04-18T15:22:14Z"
  },
  "meta": {}
}