Integrations

Enabling Analytics

You can define your analytics configuration in docs.yml. You only need to include entries for the platforms you want to connect.

docs.yml
1analytics:
2 posthog:
3 api-key: ${POSTHOG_API_KEY}
4 endpoint: https://self.hosted.posthog.com/
5 segment:
6 write-key: ${SEGMENT_WRITE_KEY}
7 intercom:
8 app-id: ${INTERCOM_APP_ID}
9 endpoint: https://intercom.custom-instance.com/
10 fullstory:
11 org-id: ${FULLSTORY_ORG_ID}

Environment Variables

If your docs configuration is public, then we do not advise adding secret values directly to docs.yml. Instead, you can reference an environment variable by using the syntax ${VARIABLE_NAME}.

If you are using GitHub Workflows to trigger docs generation, you must make sure that the environment variables are available during the workflow run.

1- name: Publish Docs
2 env:
3 FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
4 POSTHOG_API_KEY: ${{ secrets.POSTHOG_PROJECT_API_KEY }}
5 run: |
6 npm install -g fern-api
7 fern generate --docs

Postman

The Postman integration is not configured in docs.yml. Check out this page to learn more.

Connect other integrations

Enterprise feature

This feature is available only for the Enterprise plan. To get started, reach out to support@buildwithfern.com.

If you want to integrate with a third-party analytics or support platforms that Fern doesn’t directly support, you can do so using custom JS.