Skip to main content

Integrations (Workspace API keys)

Use Settings → Workspace settings → Integrations to manage workspace-scoped API keys. These keys let server-side tools or integrations act on behalf of your workspace when calling the SiteHut API.

This is separate from your personal API keys in Account settings, which identify you as a user.

Permissions​

Only members whose role allows integrations (or full workspace management) can view or create keys. If you do not see Integrations, ask a workspace admin.

Creating a key​

  1. Open Integrations.
  2. Choose Create (or equivalent).
  3. Give the key a name you will recognise later (for example Production exporter).
  4. Select scopes—each scope grants a slice of the API (read vs write, per area). Apply least privilege: only what the integration needs.
  5. Set an expiry where the UI offers it.
  6. Copy the secret once when it is shown. It cannot be retrieved again; if you lose it, revoke and create a new key.

Rotating and revoking​

  • Regenerate when a key might be exposed or an employee leaves.
  • Revoke keys you no longer use so old secrets stop working.

Technical details​

For base URL, authentication headers, and OpenAPI documentation, see API overview.

Related: API overview · Account settings · Workspace settings