---
title: "Check Health"
method: POST
path: "/v3/integrations/{id}/health-check"
tags: ["integrations-v3"]
---

# Check Health

`POST /v3/integrations/{id}/health-check`

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.

## Path parameters

- `id` string, required

## Response `200`

Successful Response

- HealthCheckResponse — Aggregate result of an integration's connection health check.
  - `status` 'pending' | 'connected' | 'partial' | 'failed', required — Overall status of a connection health check.
  - `steps` HealthCheckStepResponse[], required
    - `step` 'connectivity' | 'auth' | 'query', required — Identifies which health check step a result is for.
    - `passed` boolean, required
    - `message` string, required
    - `details` object
  - `checked_at` string, date-time, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/traversal/apis/fastapi.md) · [All operations](https://skmtc.net/traversal/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/traversal/fastapi/revisions/2134ebffd1ef/schema)