Skip to main content
GET
/
v1
/
api
/
connect
/
status
Get connection status
curl --request GET \
  --url https://api.hq.zone/v1/api/connect/status \
  --header 'Authorization: Bearer <token>'
{
  "detected": [
    {
      "confidence": 123,
      "signal_type": "<string>",
      "source": "<string>",
      "value": "<string>"
    }
  ],
  "extension": {
    "download_url": "<string>",
    "web_store_url": "<string>"
  },
  "recommendations": [
    {
      "confidence": 123,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kind": "<string>",
      "status": "<string>",
      "target_slug": "<string>",
      "category": "<string>",
      "description": "<string>",
      "display_name": "<string>",
      "icon_url": "<string>",
      "priority": "<string>",
      "rationale": "<string>",
      "reason": "<string>"
    }
  ],
  "slack": {
    "connected": true,
    "team_name": "<string>"
  },
  "teams": {
    "connected": true,
    "org_name": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Response

200 - application/json

Connection state + recommendations

detected
object[]
required

Everything the profiler detected about the org's site/DNS - shown so the tenant sees the result even when nothing maps to a connectable recommendation (e.g. HubSpot/Mailchimp, which we have no connector for yet).

extension
object
required
recommendations
object[]
required
slack
object
required
teams
object
required