GET/api/v2/referrals/alert-delivery-health

GET /api/v2/referrals/alert-delivery-health

Authentication

Send your API key in the x-api-key header on every request.

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
PendingunknownYes
DeliveringunknownYes
DeliveredunknownYes
DeadLetterunknownYes
OldestPendingAtstring (date-time)Yes
RecentFailuresarray of ReferralAlertDeliveryFailureResponseYes

Example request

curl -X GET "https://{base_url}/api/v2/referrals/alert-delivery-health" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.