ClearFox logoClearFox
← All docs

Integrations

Connect your business tools to ClearFox.

Databases

MySQL Database

  1. 1

    Create a read-only MySQL user for the AI:

    CREATE USER 'clearfox'@'%' IDENTIFIED BY 'your-password';
    GRANT SELECT ON your_database.* TO 'clearfox'@'%';
  2. 2

    If MySQL runs on the host machine, use host.docker.internal as the host.

  3. 3

    If MySQL runs in Docker, use the container name as the host.

  4. 4

    In ClearFox Admin UI → Integrations, find MySQL → click '+' to add a config. Fill in host, user, pass, db.

  5. 5

    Optionally set key_tables to highlight important tables.

PostgreSQL Database

  1. 1

    Create a read-only PostgreSQL user for the AI:

    CREATE USER clearfox WITH PASSWORD 'your-password';
    GRANT CONNECT ON DATABASE your_db TO clearfox;
    GRANT USAGE ON SCHEMA public TO clearfox;
    GRANT SELECT ON ALL TABLES IN SCHEMA public TO clearfox;
  2. 2

    If PostgreSQL runs on the host machine, use host.docker.internal as the host.

  3. 3

    In ClearFox Admin UI → Integrations, find PostgreSQL → click '+' to add a config. Fill in host, user, pass, db.

  4. 4

    Optionally set schema and key_tables.

MongoDB

  1. 1

    Create a read-only MongoDB user for the AI:

    use admin
    db.createUser({ user: "clearfox", pwd: "your-password", roles: [{ role: "read", db: "your_database" }] })
  2. 2

    In ClearFox Admin UI → Integrations, find MongoDB → click '+' to add a config. Set the URI (include database name in the path).

  3. 3

    If MongoDB runs on the host machine, use host.docker.internal as the host. If in Docker, use the container name.

Analytics & BI

Google Analytics

  1. 1

    Go to Google Cloud Console → Service Accounts and create a new service account (e.g. clearfox-analytics). No roles needed during creation.

  2. 2

    Enable the Google Analytics Data API for your Google Cloud project.

  3. 3

    Open the created service account → Keys tab → Add Key → Create new key → JSON. Download the JSON file.

  4. 4

    ⚠️ If you get an iam.disableServiceAccountKeyCreation error, your organization blocks key creation. Ask your Organization Policy Administrator to temporarily disable the iam.disableServiceAccountKeyCreation constraint in Organization Policies, or create the key for you.

  5. 5

    In Google Analytics, go to Admin → Property Access Management → + → Add users. Add the service account email with Viewer role. The email is in the downloaded JSON file — look for the client_email field (looks like clearfox-analytics@your-project.iam.gserviceaccount.com). ⚠️ Without this step you will get a 403 PermissionDenied error even if the JSON key is valid.

  6. 6

    Find your GA4 Property ID: Google Analytics → Admin → Property Settings → Property ID (9-digit number).

  7. 7

    In ClearFox Admin → Integrations, find Google Analytics → click '+'. Paste the contents of the JSON key file and enter the Property ID.

BigQuery

  1. 1

    Prerequisite: Google OAuth must be configured in ClearFox (Client ID + Secret). See Google OAuth Setup.

  2. 2

    Enable the BigQuery API in your Google Cloud project (the same project where your OAuth app lives).

  3. 3

    Find your GCP project ID in Google Cloud Console — it’s next to the project name at the top.

  4. 4

    Make sure the Google account you’ll connect has at least the BigQuery Data Viewer + BigQuery Job User roles on the project (IAM & Admin → IAM).

  5. 5

    Each user goes to Integrations → BigQuery, clicks Connect Google Account, signs in, then pastes the GCP project ID. The AI can immediately list datasets, inspect schemas and run SELECT queries.

  6. 6

    Admin alternative — service account (no per-user sign-in): paste one shared service-account key instead of OAuth. In IAM & Admin → Service Accounts create a service account, grant BigQuery Data Viewer + BigQuery Job User, add a JSON key, paste it into Admin → Integrations → BigQuery. Queries run as that shared identity; tokens never expire.

  7. 7

    With a Workspace Internal OAuth app (see Google OAuth Setup) there is no unverified-app warning and no 7-day token revoke. Scope is bigquery.readonly — DML/DDL is blocked; use the BigQuery console for writes.

Project Management

Jira

  1. 1

    Go to Atlassian API Tokens.

  2. 2

    Click 'Create API token', name it (e.g. 'ClearFox AI'), and copy the token.

  3. 3

    In ClearFox Admin UI → Integrations, find Jira → click '+' to add a config. Fill in base_url, email, api_token, and optionally default_projects.

Confluence

  1. 1

    Go to Atlassian API Tokens.

  2. 2

    Click 'Create API token', name it (e.g. 'ClearFox AI'), and copy the token.

  3. 3

    In ClearFox Admin UI → Integrations, find Confluence → click '+' to add a config. Fill in url, email, api_token.

Notion

  1. 1

    Pick one of two setups: (A) shared workspace Internal Integration token — simplest if one Notion workspace is exposed to all employees; (B) OAuth — when each user has their own Notion or you want per-user access control.

  2. 2

    (A) Internal Integration token (recommended for one shared workspace). In Notion, open Settings → Integrations → Develop or manage integrations, create an Internal integration, and under Capabilities enable content read/update/insert plus Read comments and Insert comments (needed for the comment tools). Copy its ntn_… token. In ClearFox Admin → Configs → Notion → + Add, paste it into the api_key field. Then in Notion, share each relevant page with the integration: page Connections → add it (top-level pages cascade to children).

  3. 3

    (B) OAuth — per-user. Goes through ClearFox's managed proxy (oauth.clearfox.ai) by default; nothing to configure on the admin side. Or register your own Public integration at notion.so/profile/integrations and paste its Client ID/Secret in Admin → OAuth → Notion. Each user then connects in Integrations → Notion and shares the pages they want to expose.

  4. 4

    (B) OAuth — shared workspace. If you want a single OAuth-based account shared across all users (instead of an Internal token): Admin → Configs → Notion → + Add, click Connect Notion, authorize once. Grant role access in Admin → Roles.

  5. 5

    Resolution order at runtime: personal OAuth → workspace OAuth → workspace api_key. Whichever is set first wins; the others act as fallbacks.

Communication

Gmail

  1. 1

    Prerequisite: finish Google OAuth Setup (Workspace Internal app, Gmail API enabled, Gmail scopes added). Client ID and Secret must already be saved in Admin → OAuth.

  2. 2

    If you skipped APIs earlier, enable the Gmail API in the same Google Cloud project as your OAuth client.

  3. 3

    Gmail uses per-user OAuth — each employee connects their own mailbox. There is no shared admin spreadsheet-style config.

  4. 4

    Each user opens Integrations and clicks Connect Google Account next to Gmail. Sign in with their Workspace account. On Google’s consent screen each permission is a separate checkbox — they can grant read-only and skip send/compose if they want a safer subset.

  5. 5

    After connecting, the AI can search and read mail, manage labels, create drafts, and send mail — only for that user’s mailbox, within the scopes they approved.

  6. 6

    Tip: If Connect fails with accessNotConfigured, the Gmail API is not enabled (step 2). If users outside your Workspace try to connect, Internal audience correctly blocks them — that is expected.

Slack

  1. 1

    Go to Slack API Apps and click 'Create New App' → 'From scratch'.

  2. 2

    Name it (e.g. 'ClearFox AI') and select your workspace.

  3. 3

    Go to 'OAuth & Permissions' → 'Scopes' → add Bot Token Scopes:

    channels:read, channels:history, groups:read, groups:history,
    users:read, search:read, chat:write (if you want the AI to post).
  4. 4

    Click 'Install to Workspace' and authorize.

  5. 5

    Copy the 'Bot User OAuth Token' (starts with xoxb-...).

  6. 6

    In ClearFox Admin UI → Integrations, find Slack → click '+' to add a config. Paste the bot token.

  7. 7

    Invite the bot to channels it should access: /invite @ClearFox AI

Freshservice

  1. 1

    Log in to Freshservice as an admin.

  2. 2

    Go to your profile icon → Profile Settings.

  3. 3

    On the right side, find your API Key and copy it.

  4. 4

    Your domain is the subdomain (e.g. 'mycompany' from mycompany.freshservice.com).

  5. 5

    In ClearFox Admin UI → Integrations, find Freshservice → click '+' to add a config. Fill in url and api_key.

Finance & Payments

Stripe

  1. 1

    Go to Stripe Dashboard → API Keys.

  2. 2

    Click '+ Create restricted key' (recommended over the secret key for security).

  3. 3

    Give it a name (e.g. 'ClearFox AI Read-Only').

  4. 4

    Set permissions: All Read access. Do NOT enable any Write permissions unless needed.

  5. 5

    Click 'Create key' and copy it (starts with rk_live_... or sk_live_...).

  6. 6

    In ClearFox Admin UI → Integrations, find Stripe → click '+' to add a config. Paste the API key.

  7. 7

    For test mode, use keys from 'Test mode' toggle (starts with sk_test_...).

CRM & Sales

HubSpot

  1. 1

    Go to HubSpot → Settings (gear icon) → Integrations → Private Apps.

  2. 2

    Click 'Create a private app', name it (e.g. 'ClearFox AI').

  3. 3

    Go to 'Scopes' tab and enable read scopes you need:

    crm.objects.contacts.read, crm.objects.deals.read, crm.objects.companies.read, etc.
  4. 4

    Click 'Create app' and copy the access token.

  5. 5

    In ClearFox Admin UI → Integrations, find HubSpot → click '+' to add a config. Paste the access token.

Bitrix24

  1. 1

    Log in to your Bitrix24 cloud account as an administrator.

  2. 2

    Go to Developer resourcesOtherInbound webhook.

  3. 3

    Grant the scopes you want exposed: crm (leads, deals, companies, contacts), lists (Lists / Списки), tasks, user.

  4. 4

    Copy the full webhook URL — it ends with a trailing slash, e.g. https://yourcompany.bitrix24.ru/rest/1/abc123token/.

  5. 5

    In ClearFox Admin UI → Integrations, find Bitrix24 → click '+' to add a config. Paste the webhook URL.

  6. 6

    The webhook inherits the permissions of the user who created it. Use an admin user for full read access.

Customer.io

  1. 1

    In Customer.io, go to SettingsAccount SettingsAPI Credentials.

  2. 2

    Open the App API Keys tab, click 'Create App API Key', name it (e.g. 'ClearFox AI') and copy it. This powers all reads.

  3. 3

    Note your data region — US accounts use customer.io, EU accounts use the EU data center. Pick the matching Region in the config.

  4. 4

    Optional (for writes): on the Track API Keys tab, copy your Site ID and a Track API Key — these enable identifying people and tracking events.

  5. 5

    In ClearFox Admin UI → Integrations, find Customer.io → click '+' to add a config. Paste the App API key, set the region, and (optionally) the Track Site ID and Track API key.

HR & People

BambooHR

  1. 1

    Log in to BambooHR as an admin.

  2. 2

    Click your name → API Keys.

  3. 3

    Click 'Add New Key', name it (e.g. 'ClearFox AI'), and copy the key.

  4. 4

    Your subdomain is the part before .bamboohr.com (e.g. 'mycompany').

  5. 5

    In ClearFox Admin UI → Integrations, find BambooHR → click '+' to add a config. Fill in subdomain and api_key.

HiBob

  1. 1

    Log in to HiBob as an admin.

  2. 2

    Go to Settings → Integrations → Service Users.

  3. 3

    Create a new service user and grant it read access to the employee data categories you need — at minimum Basic info, Work and Employment / Lifecycle — plus Time off. ⚠️ HiBob silently omits any category the service user cannot read, so without Work / Employment access the assistant sees employee names but empty department, title, site and status — headcount and org-structure answers come back blank.

  4. 4

    For hiring / ATS tools (candidates, applications, job ads), also grant the service user read access to the Hiring data categories. Without it the hiring tools return permission errors while employee tools keep working.

  5. 5

    Copy the Service User ID and Token.

  6. 6

    In ClearFox Admin UI → Integrations, find HiBob → click '+' to add a config. Fill in api_token and service_user_id.

Productivity & Docs

Google Sheets

  1. 1

    Prerequisite: finish Google OAuth Setup (Workspace Internal app + Sheets API + spreadsheet scopes).

  2. 2

    If needed, enable the Google Sheets API in the same Google Cloud project as your OAuth client.

  3. 3

    Go to Admin → OAuth (or Integrations) and Connect Google Account with a Workspace user that can open the spreadsheets you need.

  4. 4

    Go to Admin → Integrations → Google Sheets → click +. Select the connected account and paste the spreadsheet URL or ID. Users can also add their own sheets under Integrations → Google Sheets — the connected Google account must have access (owner or shared).

Google Calendar

  1. 1

    Prerequisite: finish Google OAuth Setup (Workspace Internal app + Calendar API + calendar scopes).

  2. 2

    If needed, enable the Google Calendar API in your Google Cloud project.

  3. 3

    Google Calendar uses per-user OAuth — each user connects their own account. No admin-level config in Integrations.

  4. 4

    Each user opens IntegrationsConnect Google Account next to Google Calendar, signs in with their Workspace account, and approves access.

  5. 5

    The AI can then list events, check free/busy, create events with Google Meet links and reminders, and search the calendar — scoped to that user's account.

Google Drive

  1. 1

    Prerequisite: finish Google OAuth Setup (Workspace Internal app + Drive API + drive scopes).

  2. 2

    If needed, enable the Google Drive API in your Google Cloud project.

  3. 3

    Google Drive uses per-user OAuth — each user connects their own account. No admin-level config in Integrations.

  4. 4

    Each user opens IntegrationsConnect Google Account next to Google Drive. On the consent screen each permission is a separate checkbox — they can grant read-only and skip full Drive access.

  5. 5

    The AI can then search and read files (Docs/Sheets/Slides exported as text), create folders, upload, move, rename, share and trash — scoped to that user's Drive.

Google Docs

  1. 1

    Prerequisite: finish Google OAuth Setup (Workspace Internal app + Docs API + Drive API + documents scopes).

  2. 2

    If needed, enable the Google Docs API and the Google Drive API (used to search documents).

  3. 3

    Google Docs uses per-user OAuth — each user connects their own account under IntegrationsConnect Google Account next to Google Docs.

  4. 4

    The AI can then search documents, read full text, create docs, append and replace text — scoped to that user's account.

Google Slides

  1. 1

    Prerequisite: finish Google OAuth Setup (Workspace Internal app + Slides API + Drive API + presentations scopes).

  2. 2

    If needed, enable the Google Slides API and the Google Drive API (used to search presentations).

  3. 3

    Google Slides uses per-user OAuth — each user connects under IntegrationsConnect Google Account next to Google Slides.

  4. 4

    The AI can then search and read presentations, create decks, add slides, replace template text, and delete slides — scoped to that user's account.

Microsoft Excel

  1. 1

    Prerequisite: Microsoft 365 OAuth must be configured first. See Microsoft 365 OAuth Setup.

  2. 2

    In Azure Portal → App registrations, open your ClearFox app → API permissionsAdd a permission → Microsoft Graph → Delegated permissions. Add: Files.ReadWrite.All, User.Read, offline_access. Click Grant admin consent — some tenants require a tenant admin to approve Files.ReadWrite.All before users can connect.

  3. 3

    Go to Admin → Integrations → Microsoft Excel (or Integrations for a personal connection) → click +. Connect a Microsoft account that can open the workbook, then paste the SharePoint or OneDrive Excel link into Workbook URL or ID. SharePoint sharing links (e.g. …sharepoint.com/:x:/r/…) work — ClearFox resolves them via Microsoft Graph.

  4. 4

    The connected Microsoft account must have access to the workbook (owner or shared with edit/view rights matching the tools you use).

  5. 5

    The AI can then list worksheets, read ranges, search cells, write values and append rows — scoped to that workbook.

  6. 6

    Tip: If consent fails with an admin-approval error, an Azure AD admin must grant admin consent for the app (step 2) for the whole organization.

Microsoft OneDrive & SharePoint

  1. 1

    Prerequisite: Microsoft 365 OAuth must be configured first. See Microsoft 365 OAuth Setup.

  2. 2

    In Azure Portal → App registrations, open your ClearFox app → API permissionsAdd a permission → Microsoft Graph → Delegated permissions. Add: Files.Read.All, Sites.Read.All, User.Read, offline_access. Click Grant admin consentSites.Read.All and Files.Read.All often require tenant admin approval.

  3. 3

    Microsoft Files uses per-user OAuth — each user connects their own account under Integrations next to Microsoft OneDrive & SharePoint. There is no per-file config; the AI searches across that user's OneDrive and SharePoint sites.

  4. 4

    The AI can search files, list folders and SharePoint sites, read metadata, and extract text from Word, PDF and plain-text files. For Excel workbooks, connect the file via Microsoft Excel instead.

  5. 5

    Tip: If users see a permissions error after connecting, make sure admin consent was granted in step 2 for the entire organization.

Microsoft Calendar (Office 365)

  1. 1

    Prerequisite: Microsoft 365 OAuth must be configured first. See Microsoft 365 OAuth Setup.

  2. 2

    In Azure Portal → App registrations, open your ClearFox app → API permissionsAdd a permission → Microsoft Graph → Delegated permissions. Add: Calendars.ReadWrite, User.Read, People.Read, offline_access. Click Grant admin consent.

  3. 3

    Microsoft Calendar uses per-user OAuth — each user connects their own account. There is no admin-level config needed in Integrations.

  4. 4

    Each user goes to Integrations and clicks Connect Microsoft Account next to Microsoft Calendar. This opens a Microsoft login popup. After approving, their calendar is immediately available to the AI.

  5. 5

    The AI can then list events, check availability, create meetings, and search the calendar — all scoped to that user's own account.

  6. 6

    Tip: If users see a permissions error after connecting, make sure admin consent was granted in step 2 for the entire organization.

Microsoft Teams

  1. 1

    Prerequisite: Microsoft 365 OAuth must be configured first. See Microsoft 365 OAuth Setup.

  2. 2

    In Azure Portal → App registrations, open your ClearFox app → API permissionsAdd a permission → Microsoft Graph → Delegated permissions. Add: Team.ReadBasic.All, Channel.ReadBasic.All, ChannelMessage.Send, Chat.ReadWrite, User.Read, offline_access. Click Grant admin consent.

  3. 3

    Microsoft Teams uses per-user OAuth — each user goes to Integrations and clicks Connect Microsoft Account next to Microsoft Teams. Messages the AI sends appear in Teams as sent by that user.

  4. 4

    The AI can then list the user's teams, channels and chats, read chat history, send messages to channels, and start one-on-one chats with colleagues by email.

  5. 5

    Bot-style notifications (recommended for scheduled reports): create a dedicated Microsoft 365 user such as ai@yourcompany.com named e.g. ‘ClearFox AI’ (a license with Teams is required), add it to the teams and channels it should post to, and connect it in Admin → Integrations → Microsoft Teams as a workspace connection. Messages sent through this connection appear as the ‘ClearFox AI’ user — in channels and in one-on-one chats with any employee.

  6. 6

    Note: Microsoft Graph only allows sending Teams messages on behalf of a signed-in user (delegated permissions). App-only tokens cannot send messages — this is a Microsoft platform restriction, which is why the service-account approach above is used for bot-style messaging.

ERP & Business

Odoo ERP

  1. 1

    Log in to Odoo as an admin.

  2. 2

    Go to Settings → Users & Companies → your user → Preferences tab.

  3. 3

    Scroll to 'API Keys' section → click 'New API Key', name it, and copy the key.

  4. 4

    Your Odoo URL is the base URL of your instance (e.g. https://mycompany.odoo.com).

  5. 5

    The database name is visible in the URL or in Settings → Database Manager.

  6. 6

    In ClearFox Admin UI → Integrations, find Odoo → click '+' to add a config. Fill in url, db, username, api_key.

Automation

Make (Integromat)

  1. 1

    Log in to Make.com → click your profile icon (bottom-left) → Profile.

  2. 2

    Scroll to the API section → click 'Add API token'. Select all scopes you need (at minimum: scenarios, connections, organizations) → click 'Save'. Copy the token immediately (it is shown only once).

  3. 3

    Find your Organization ID: go to Organization settings → the ID is in the URL: make.com/organization/ORG_ID/....

  4. 4

    Find your Team ID (optional): click on a team → the ID is in the URL: make.com/organization/.../team/TEAM_ID/....

  5. 5

    In ClearFox Admin UI → Integrations, find Make → click '+' to add a config. Fill in api_token, and optionally team_id and zone.

Zapier

  1. 1

    Log in to Zapier → go to Settings (gear icon) → API Keys.

  2. 2

    Click 'Create API Key', name it (e.g. 'ClearFox AI'), and copy the key.

  3. 3

    In ClearFox Admin UI → Integrations, find Zapier → click '+' to add a config. Paste the API key.

  4. 4

    The API key provides read access to your Zaps, task history, and folders.

Developer Tools

Datadog

  1. 1

    Datadog read APIs require both an API key and an Application key. Use a dedicated read-only service account where possible — the Application key inherits the user's permissions.

  2. 2

    Find your Site (region): log in to Datadog and check the URL bar. app.datadoghq.com → site is datadoghq.com (US1, default). Other sites: datadoghq.eu (EU), us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ddog-gov.com. ⚠️ Using the wrong site returns 403 Forbidden even with valid keys.

  3. 3

    Create the API key: go to Organization Settings → API Keys+ New Key. Name it (e.g. ClearFox AI) and copy the value.

  4. 4

    Create the Application key: go to Organization Settings → Application Keys+ New Key. Name it (e.g. ClearFox AI) and copy the value. ⚠️ The API key alone is not enough for read endpoints; the Application key is mandatory.

  5. 5

    ⚠️ Don't confuse Key ID with Key value. The Application Keys table shows the Key ID (UUID with dashes, 36 chars) — that is not the key. Click the row to open the details panel and copy the Key field (40 hex chars, no dashes). If the value is no longer shown there, create a new key — Datadog reveals the full value only at creation time. Pasting the Key ID produces 401 Unauthorized on every endpoint while the API key validation still appears to succeed.

  6. 6

    Scope the Application key (recommended): open the new key → Scopes tab → switch from Inherit user permissions to Custom scopes. Enable read-only scopes for what the AI needs: monitors_read, metrics_read, logs_read_data, events_read, dashboards_read, incident_read, slos_read, hosts_read. Without scopes the key has full access of the user that created it.

  7. 7

    In ClearFox Admin UI → Integrations, find Datadog → click '+' to add a config. Set site (e.g. datadoghq.com or datadoghq.eu), paste api_key and app_key.

  8. 8

    Common errors: 403 Forbidden → wrong site, missing scope on the App key, or the user that created the App key was deactivated. 401 Unauthorized → API key is invalid or revoked.

Sentry

  1. 1

    ClearFox reads Sentry only — issues, stack traces, releases and error volume stats. It never resolves, assigns or modifies anything.

  2. 2

    Recommended token type: an internal integration — it is org-scoped and keeps working if an employee leaves. In Sentry go to Settings → Developer Settings → Custom IntegrationsCreate New IntegrationInternal Integration. Name it (e.g. ClearFox AI).

  3. 3

    Set Permissions: Issue & EventRead, ProjectRead, OrganizationRead. Leave everything else at No Access, then Save Changes.

  4. 4

    On the integration page scroll to TokensNew Token and copy the value — it is shown only once.

  5. 5

    Alternative: a personal User Auth Token with scopes event:read, project:read, org:read also works, but it is tied to your user account.

  6. 6

    Find your organization slug in the Sentry URL: sentry.io/organizations/SLUG/... or the subdomain SLUG.sentry.io. You can skip it if the token sees exactly one organization — ClearFox detects it automatically.

  7. 7

    Self-hosted Sentry: set url to your instance base URL (e.g. https://sentry.yourcompany.com). The API is identical; create the token the same way in your instance settings.

  8. 8

    In ClearFox Admin UI → Integrations, find Sentry → click '+' to add a config. Paste auth_token; fill url and org only if needed.

  9. 9

    Common errors: 401 Unauthorized → token invalid or revoked. 403 Forbidden → missing Read permission on the integration. "Token sees multiple organizations" → set the org slug explicitly.

Grafana (Logs & Metrics)

  1. 1

    Log in to Grafana as an admin and open Administration → Users and access → Service accounts (Grafana 9+). On older versions use Configuration → API keys.

  2. 2

    Click Add service account, name it (e.g. ClearFox AI), and set role to Viewer. Viewer is enough to query datasources, dashboards, and alert state — the AI never writes to Grafana.

  3. 3

    On the service account page, click Add service account token, give it any name, and copy the token (starts with glsa_). The token is shown only once.

  4. 4

    Datasources must already be configured in Grafana itself — ClearFox queries them through Grafana's datasource proxy. Typical setup: Loki for logs, Prometheus for metrics. No extra credentials needed on ClearFox side.

  5. 5

    Your URL is the Grafana base URL, e.g. https://grafana.yourcompany.com. If Grafana is on the same private network as ClearFox you can also use the internal URL.

  6. 6

    In ClearFox Admin UI → Integrations, find Grafana → click + to add a config. Fill in url and api_key (paste the glsa_ token).

  7. 7

    Querying logs: the AI uses LogQL via Loki, e.g. {app="api"} |= "error". It can list available labels and values automatically. If you have multiple Loki datasources, the AI will ask which one to use.

  8. 8

    Self-hosted Grafana with self-signed TLS: use a publicly trusted certificate (Caddy / Let's Encrypt) or expose Grafana over plain HTTP on the internal network — ClearFox does not skip TLS verification by design.

Cloudflare (Analytics)

  1. 1

    ClearFox reads Cloudflare analytics only (HTTP traffic, security/WAF events, DNS queries, origin 5xx errors) — it never changes DNS, firewall, or any settings. A single scoped, read-only API token covers every zone in the account.

  2. 2

    Create the token: go to My Profile → API TokensCreate TokenCreate Custom Token.

  3. 3

    Add these Permissions (all Read): AccountAccount Analytics → Read; ZoneAnalytics → Read; ZoneZone → Read. Zone Read lets the AI list your domains and find zone IDs; Analytics Read powers the reports.

  4. 4

    Under Account Resources select your account, and under Zone Resources choose All zones (or pick specific zones). Continue, then Create Token and copy the value — it is shown only once.

  5. 5

    In ClearFox Admin UI → Integrations, find Cloudflare → click '+' to add a config and paste api_token.

  6. 6

    Note on numbers: Cloudflare samples high-volume traffic, so request and bandwidth figures are sampling-adjusted estimates and may differ slightly from the dashboard. Common errors: Authentication error → token missing Analytics Read or Zone Read; empty security results → the dataset window is limited (often ~72h on lower plans) — narrow the time range.

Git Repositories

  1. 1

    Generate a dedicated SSH deploy key (no passphrase):

    ssh-keygen -t ed25519 -C "clearfox-git" -f ~/.ssh/clearfox_git -N ""
  2. 2

    Copy the public key — you will need it in the next step:

    cat ~/.ssh/clearfox_git.pub
  3. 3

    Add the public key as a deploy key in your Git hosting. Grant read-only access.
    GitHub: Managing deploy keys · GitLab: Deploy keys

  4. 4

    Base64-encode the private key (the value ClearFox needs):

    cat ~/.ssh/clearfox_git | base64 -w0 ; echo
  5. 5

    On macOS use base64 without -w0 and strip line breaks:

    cat ~/.ssh/clearfox_git | base64 | tr -d '\n' ; echo
  6. 6

    In ClearFox Admin UI → Integrations, find Git → click '+' to add a config. Paste the base64 SSH key and repos (comma-separated URL|branch).

  7. 7

    The server will clone repos on startup and provide code search and file reading tools.

GitLab

  1. 1

    ClearFox connects to GitLab (self-hosted or gitlab.com) via the REST API: merge requests with diffs and comments, issues (read and create), CI pipelines with job logs, repository files and search.

  2. 2

    Create an access token. Recommended: a project or group access token so it is not tied to a person — in GitLab open the project/group → Settings → Access tokens. A personal token from Preferences → Access tokens also works.

  3. 3

    Select the scope: api for full functionality (the AI can post MR comments and create issues) or read_api for strictly read-only access. Role Reporter is enough for reading, Developer for commenting.

  4. 4

    Copy the token (glpat-...) — it is shown only once.

  5. 5

    In ClearFox Admin UI → Integrations, find GitLab → click + to add a config. Fill in base_url (e.g. https://gitlab.yourcompany.com) and token. Self-hosted instances on a private network work — use the internal URL.

  6. 6

    Common errors: 401 Unauthorized → token invalid, expired or revoked (GitLab tokens have an expiry date — check it). 403 Forbidden → the token role is too low for the action (e.g. commenting needs Developer). 404 on an existing project → the token cannot see that project — use a group token or widen the scope.

REST API (Generic)

  1. 1

    Generic connector for any HTTP API that has no dedicated ClearFox integration — internal services, niche SaaS, self-hosted tools. The AI can call GET/POST/PUT/PATCH/DELETE endpoints relative to a base URL you configure.

  2. 2

    In ClearFox Admin UI → Integrations, find REST API → click + to add a config. Fill in base_url (e.g. https://api.example.com/v1).

  3. 3

    If the API needs authentication, set auth_header (e.g. Authorization or X-Api-Key) and auth_value (e.g. Bearer xxx or the raw key). The auth header is only ever sent to the configured host — the AI cannot redirect it elsewhere.

  4. 4

    Optional: set openapi_url to the API's OpenAPI/Swagger JSON — the AI can then discover available endpoints by itself instead of guessing paths.

  5. 5

    Add a short label and a description so the AI knows what the API is for — this strongly improves how well it uses the integration.

  6. 6

    Tip: add one config per API. Multiple configs appear to the AI as separate named instances.

Web Fetch

  1. 1

    No configuration needed. This server fetches URLs and extracts content as markdown.

  2. 2

    It works out of the box with no API keys required.

Sequential Thinking

  1. 1

    No configuration needed. This server provides structured step-by-step reasoning.

  2. 2

    It works out of the box with no API keys required.

Memory

  1. 1

    No configuration needed. This server provides persistent memory storage for the AI.

  2. 2

    It works out of the box with no API keys required.

Custom MCP servers

Add your own MCP server

  1. 1

    On top of the built-in integrations, each user can connect their own remote MCP servers. Go to Integrations → Custom MCP servers.

  2. 2

    Click + Add server and fill in: a short name (lowercase, used as the tool prefix — e.g. context7), the server URL (must be https://), and a short description of what it is for (the assistant uses this to decide when to call it — or click Fill with AI to generate one).

  3. 3

    Choose Authentication: None for open servers; Authorization header to paste a token (e.g. Bearer xxx); or OAuth when the provider asks you to sign in (see the Customer.io example below).

  4. 4

    For header/none servers, click Test connection to list the tools, then Save. For OAuth, Save first, then Authorize and complete the sign-in popup — the status turns to ✓ Connected.

  5. 5

    The server's tools become available in your own chats and personal agents only, named name_tool (e.g. context7_query-docs). They are not shared with other users or admins.

  6. 6

    Security: a custom server is third-party code you choose to trust — its tools and responses reach the assistant the same as built-in ones. The portal only accepts public https:// URLs (internal/private addresses are blocked) and never sends a custom server any other integration's data or credentials.

Example: OAuth server (Customer.io, Notion, Linear…)

  1. 1

    Many hosted MCP servers (e.g. Customer.io, Notion, Linear) authenticate with OAuth — you sign in to grant access instead of pasting a token.

  2. 2

    In Integrations → Custom MCP servers, add a server with the provider's MCP URL (e.g. https://mcp-eu.customer.io/mcp) and set Authentication to OAuth. No client ID or secret is needed — the portal registers itself automatically.

  3. 3

    Click Save, then Authorize. A popup opens the provider's sign-in / consent screen; approve access to your workspace.

  4. 4

    After the popup closes the server shows ✓ Connected and its tools are ready. Use Disconnect to revoke, or Re-authorize to switch accounts. Tokens are refreshed automatically.

Example: Context7 (live library docs)

  1. 1

    Context7 serves up-to-date documentation for thousands of libraries and frameworks as MCP tools.

  2. 2

    (Optional) Create an API key at context7.com/dashboard for higher rate limits. Context7 also works without a key.

  3. 3

    In Integrations → Custom MCP servers, add a server: name context7, URL https://mcp.context7.com/mcp, and (if you made a key) Authorization Bearer ctx7sk-….

  4. 4

    Save. The assistant can now resolve a library and pull its docs on demand via the context7_* tools.