SupportIntercom

Intercom

Add the Intercom Messenger widget to your documentation for live chat and support.

Intercom Messenger adds a live chat widget to your documentation site so readers can reach your support team directly. Enable the integration to display the Intercom chat bubble on all published pages.

Prerequisites

  • An Intercom account with Messenger configured

  • Your Intercom app ID

  • Publishing access to your documentation project

Configure from the Editor

Open Site Config

In the Editor, click Site Config in the top toolbar.

Navigate to Integrations

Select Integrations from the left sidebar.

Enable Intercom

Select Intercom and enter your app ID.

Publish

Click Publish to deploy the integration to your live site.

Configure via documentation.json

Add the intercom key under integrations in your documentation.json:

{
  "integrations": {
    "intercom": {
      "appId": "your_app_id"
    }
  }
}
PropertyTypeRequiredDescription
appIdstringYesYour Intercom app ID

This is your Intercom App ID (found under installation settings), not an API key. The App ID is a short alphanumeric string like abc123de.

Where to find your app ID

  1. Sign in to Intercom.

  2. Go to Settings → Installation → Web.

  3. Copy the App ID displayed in the installation instructions.

User metadata

When a reader starts an Intercom conversation from your documentation site, the widget automatically sends the following attributes to Intercom as custom properties on the conversation:

AttributeDescription
Organization IDThe unique identifier for your organization
Organization nameThe display name of your organization
Plan typeThe current Documentation.AI plan (Starter, Standard, Professional)
Documentation IDThe unique identifier for this documentation project
Documentation nameThe display name of this documentation project

Your support team sees these attributes in the Intercom inbox alongside the conversation, so they can immediately identify which account and documentation project the user is asking about without asking for additional context.

What's next

Was this page helpful?