> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Onboarding

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

### Path parameters

<ParamField path="brand_id" type="string (uuid)" required />

### Request body

`object`

<ParamField body="gorgias" type="object" />

<ParamField body="shopify" type="object" />

<ParamField body="recharge" type="object" />

<ParamField body="activate" type="boolean">
  Also activate the brand once connectors are stored (connect only)
</ParamField>

### Response

`object`

<ResponseField name="gorgias" type="object">
  Present when `gorgias` credentials were supplied.

  <Expandable title="gorgias">
    <ResponseField name="healthy" type="boolean" required />

    <ResponseField name="error" type="string" required>
      Why the probe failed; null when healthy.
    </ResponseField>

    <ResponseField name="latency_ms" type="integer" required>
      Probe round-trip time in milliseconds.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="shopify" type="object">
  Present when `shopify` credentials were supplied.

  <Expandable title="shopify">
    <ResponseField name="healthy" type="boolean" required />

    <ResponseField name="error" type="string" required>
      Why the probe failed; null when healthy.
    </ResponseField>

    <ResponseField name="latency_ms" type="integer" required>
      Probe round-trip time in milliseconds.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="recharge" type="object">
  Present when `recharge` credentials were supplied.

  <Expandable title="recharge">
    <ResponseField name="healthy" type="boolean" required />

    <ResponseField name="error" type="string" required>
      Why the probe failed; null when healthy.
    </ResponseField>

    <ResponseField name="latency_ms" type="integer" required>
      Probe round-trip time in milliseconds.
    </ResponseField>
  </Expandable>
</ResponseField>

### 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                                                                                                                                  |

<RequestExample>
  ```bash cURL theme={null}
  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": "ada.lovelace@example.com",
      "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
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "gorgias": {
      "healthy": true,
      "error": "string",
      "latency_ms": 250
    },
    "shopify": {
      "healthy": true,
      "error": "string",
      "latency_ms": 250
    },
    "recharge": {
      "healthy": true,
      "error": "string",
      "latency_ms": 250
    }
  }
  ```
</ResponseExample>