Check webhook health

Query available failure and success times and the duration of the failure episode.

GEThttps://api.raims.com/v1/webhooks/{webhook_id}/health

Query the destination's known health based on sending attempts. Times may appear with a delay; the request does not test the URL or confirm that the receiver is available now.

See Check destination health to interpret statuses and the duration of failures.

Path Params

webhook_idstringrequired

Webhook identifier received at creation or in the list.

Up to 26 characters

Responses

For common errors, see HTTP response codes.

Updated 13 hours ago

Language

Credentials

Header

cURL Request

curl --request GET \
  --url https://api.raims.com/v1/webhooks/%7Bwebhook_id%7D/health \
  --header 'accept: application/json'

Response

Click Try it to send a request and see the response here. Or choose an example:

application/json

Check webhook health

Path Params

Responses

200OK

400Bad Request

404Not Found