Onboarding

Per-connector read-only probe results; nothing is stored. One key per credential supplied in the request — connectors not supplied are omitted.

POST /v1/onboarding/{brand_id}/test

cURL

curl --request POST \
  --url 'https://api.workstream.stateset.com/v1/onboarding/{brand_id}/test' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "gorgias": {
    "subdomain": "string",
    "email": "[e-mail]",
    "api_key": "YOUR_API_KEY",
    "webhook_secret": "YOUR_API_KEY"
  },
  "shopify": {
    "domain": "string",
    "access_token": "YOUR_API_KEY",
    "webhook_secret": "YOUR_API_KEY"
  },
  "recharge": {
    "api_token": "YOUR_API_KEY",
    "webhook_secret": "YOUR_API_KEY"
  },
  "activate": true
}'

200

{
  "gorgias": {
    "healthy": true,
    "error": "string",
    "latency_ms": 250
  },
  "shopify": {
    "healthy": true,
    "error": "string",
    "latency_ms": 250
  },
  "recharge": {
    "healthy": true,
    "error": "string",
    "latency_ms": 250
  }
}

Path parameters

brand_id · string (uuid) · required

Request body

object

gorgias · object

shopify · object

recharge · object

activate · boolean

Also activate the brand once connectors are stored (connect only)

Response

object

gorgias · object

Present when gorgias credentials were supplied.

Show gorgias

healthy · boolean · required

error · string · required

Why the probe failed; null when healthy.

latency_ms · integer · required

Probe round-trip time in milliseconds.

shopify · object

Present when shopify credentials were supplied.

Show shopify

healthy · boolean · required

error · string · required

Why the probe failed; null when healthy.

latency_ms · integer · required

Probe round-trip time in milliseconds.

recharge · object

Present when recharge credentials were supplied.

Show recharge

healthy · boolean · required

error · string · required

Why the probe failed; null when healthy.

latency_ms · integer · required

Probe round-trip time in milliseconds.

Status codes

Code	Meaning
200	Per-connector read-only probe results; nothing is stored. One key per credential supplied in the request — connectors not supplied are omitted.
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/onboarding/{brand_id}/test' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "gorgias": {
    "subdomain": "string",
    "email": "[e-mail]",
    "api_key": "YOUR_API_KEY",
    "webhook_secret": "YOUR_API_KEY"
  },
  "shopify": {
    "domain": "string",
    "access_token": "YOUR_API_KEY",
    "webhook_secret": "YOUR_API_KEY"
  },
  "recharge": {
    "api_token": "YOUR_API_KEY",
    "webhook_secret": "YOUR_API_KEY"
  },
  "activate": true
}'

200

{
  "gorgias": {
    "healthy": true,
    "error": "string",
    "latency_ms": 250
  },
  "shopify": {
    "healthy": true,
    "error": "string",
    "latency_ms": 250
  },
  "recharge": {
    "healthy": true,
    "error": "string",
    "latency_ms": 250
  }
}