Check connector health

Live probe of one stored connector.

POST /v1/brands/{brand_id}/connectors/{connector_id}/health

cURL

curl --request POST \
  --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/connectors/{connector_id}/health' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "connector_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "connector_key": "string",
  "connector_type": "string",
  "healthy": true,
  "latency_ms": 250,
  "error": "string",
  "checked_at": "2026-08-31T14:22:05Z"
}

Path parameters

brand_id · string (uuid) · required

connector_id · string (string) · required

Request body

JSON body of type GenericObject.

Response

object

connector_id · string (uuid) · required

connector_key · string · required

connector_type · string · required

healthy · boolean · required

latency_ms · integer · required

error · string

checked_at · string (date-time) · required

Status codes

Code	Meaning
200	Live probe of one stored connector.
400	Validation error
401	Unauthorized
404	Not found
429	Rate limited
500	Internal error

cURL

curl --request POST \
  --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/connectors/{connector_id}/health' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "connector_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "connector_key": "string",
  "connector_type": "string",
  "healthy": true,
  "latency_ms": 250,
  "error": "string",
  "checked_at": "2026-08-31T14:22:05Z"
}