integrations-v3

Check Health

Run a connection health check against an integration instance.

Executes a Temporal workflow that fetches the instance credentials and verifies they authenticate successfully against the third-party system.

Permissions: users with integration-setup permission on the owning org.

Returns HTTP 404 if the instance does not exist in the caller's org. Returns HTTP 501 if no health checker is registered for the integration type.

post/v3/integrations/{id}/health-check

Path parameters

idstring required

Successful Response

status'pending' | 'connected' | 'partial' | 'failed' required

Overall status of a connection health check.

checked_atstring date-time required

No changes recorded. 6 of the 23 revisions have no diff computed, so they could not be searched.