Skip to main content
POST
Trigger a health check

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integration_id
string<uuid>
required

Response

Successful Response

Response model for a single health check result.

checked_at
string<date-time>
required

When the health check was performed.

id
string<uuid>
required
status
enum<string>
required

Health check status: healthy, warning, or error.

Available options:
healthy,
warning,
error
error_code
string | null

Machine-readable error code.

error_message
string | null

Human-readable error message.