capabilities.work

Endpoint Health Check

A 3-step recipe with Svix. We can help you get access.

Recipe · 3 steps

Endpoint Health Check

with Svix · Webhook & Event Subscription Management

Send an example message to an endpoint and report its delivery stats.

  1. Confirm the endpoint exists before testing it. Returns 200 with the endpoint object.
  2. Send the event type's example payload to the endpoint to exercise it. Returns 202 Accepted with the message object.
  3. Read the endpoint's delivery statistics to report success and failure counts. Returns 200 with the stats object.
What you'll need to have ready
  • appId: The id or uid of the application owning the endpoint.
  • endpointId: The id or uid of the endpoint to health check.
  • eventType: The event type name whose example payload is sent.
For your developer

Arazzo workflow svix:endpoint-health-check, 3 operations: v1.endpoint.get → v1.endpoint.send-example → v1.endpoint.get-stats. Specs on APIs.io.