Skip to navigation

Intercom

View as Markdown

Integrate Intercom to add the Messenger widget to your documentation, allowing users to access your help center and contact support directly from the docs.

1

Get your Intercom app ID

Your Intercom app_id, also known as the Intercom workspace ID, is a unique code assigned to your app when you create it in Intercom.

Find it under Settings > Workspace > General in the “Workspace name & time zone” tab.

See Intercom’s FAQ for more details.

2

Add Intercom to docs.yml

In your docs.yml file, add your Intercom configuration:

docs.yml
analytics:
intercom:
app-id: ${INTERCOM_APP_ID}
3

(Optional) Configure a custom endpoint

If you use a custom Intercom instance, add the endpoint to your configuration:

docs.yml
analytics:
intercom:
app-id: ${INTERCOM_APP_ID}
api-base: ${INTERCOM_ENDPOINT} # e.g. https://intercom.custom-instance.com