Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Webhooks

Get the webhooks health status

Returns the health status (healthy, unhealthy, or unknown) of the webhooks system based on the last ten minutes of activity.

📘 System Access Authentication

This endpoint uses the Bearer Auth scheme with the system-level access token in the HTTP Authorization header

scope: webhook_subscriptions:read

get/v1/webhooks/health_check

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Response

successful

status'healthy' | 'unhealthy' | 'unknown'

Latest health status of the webhooks system

last_checked_atstring date-time

ISO8601 timestamp of the last successful health check with millisecond precision