Integrations

The integrations field in writedocs.json turns on a third-party provider by name — you supply the ID your account gave you, writedocs renders that provider’s own install snippet on every page.

{
  "integrations": {
    "ga4": { "measurementId": "G-XXXXXXXXXX" }
  }
}

That’s the whole setup for Google Analytics 4. No scripts field, no snippet to paste in yourself. Turn on any subset of the seven supported providers — including several analytics providers at once if you’re migrating from one to another.

ga4

{
  "integrations": {
    "ga4": { "measurementId": "G-XXXXXXXXXX" }
  }
}

measurementId is the G-XXXXXXXXXX ID from your GA4 property’s data stream settings.

googleTagManager

{
  "integrations": {
    "googleTagManager": { "containerId": "GTM-XXXXXXX" }
  }
}

containerId is the GTM-XXXXXXX ID from your Tag Manager container. If you’re already using GTM to manage GA4 and other tags, use this instead of ga4 — don’t turn both on together, or GA4 will load twice.

plausible

{
  "integrations": {
    "plausible": { "domain": "docs.example.com" }
  }
}

domain is the site domain you registered in Plausible. If you’re on a self-hosted Plausible instance, point src at your own instance’s script URL:

{
  "integrations": {
    "plausible": {
      "domain": "docs.example.com",
      "src": "https://plausible.example.com/js/script.js"
    }
  }
}

fathom

{
  "integrations": {
    "fathom": { "siteId": "ABCDEFGH" }
  }
}

siteId is the site ID from your Fathom dashboard.

posthog

{
  "integrations": {
    "posthog": { "apiKey": "phc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }
  }
}

apiKey is your project API key. If your PostHog project is on the EU cloud (or self-hosted), set apiHost too — it defaults to the US cloud host:

{
  "integrations": {
    "posthog": {
      "apiKey": "phc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "apiHost": "https://eu.i.posthog.com"
    }
  }
}

umami

{
  "integrations": {
    "umami": { "websiteId": "11111111-2222-3333-4444-555555555555" }
  }
}

websiteId is the UUID Umami assigned your site. If you’re self-hosting Umami, point src at your own instance’s script:

{
  "integrations": {
    "umami": {
      "websiteId": "11111111-2222-3333-4444-555555555555",
      "src": "https://umami.example.com/script.js"
    }
  }
}

askAi

{
  "integrations": {
    "askAi": { "id": "yourTeamId/yourBotId" }
  }
}

Turns on an “Ask AI” chat widget, backed by DocsBot, so readers can ask questions and get answers sourced from your own docs content without leaving the page.

id is the combined teamId/botId string from your bot’s own embed snippet in the DocsBot dashboard (Settings → Embeddable Widget) — it’s one opaque value, not two separate fields. The field is named askAi rather than docsbot deliberately: it’s the feature name as it appears on your site, independent of which provider sits behind it.

The widget loads last on the page (after everything else, including your own scripts.body entries) — it’s a floating chat bubble, not something else on the page depends on, so there’s no reason to load it any earlier.

What this doesn’t cover

There’s no per-page opt-out, no consent-banner gating, and no page-feedback (thumbs up/down) widget yet — the feedback widget in particular has no storage backend to save responses to, so it hasn’t been built. If your site needs cookie-consent gating before analytics scripts load, or a provider not listed here, use the generic scripts field instead and paste in that provider’s own snippet (wrapped in whatever consent-check logic you need) directly.