Analytics & integrations

Fullstory

View as Markdown

Integrate Fullstory to capture session replays and user interactions in your documentation.

1

Get your Fullstory Org ID

Your Org ID appears in the URL when you log in to Fullstory:

https://app.fullstory.com/ui/<ORG_ID>/home

Alternatively, find it in Settings > Data Capture and Privacy > Fullstory Setup in the snippet code as window['_fs_org'].

See Fullstory’s guide for more details.

2

Add Fullstory to docs.yml

In your docs.yml file, add your Fullstory Org ID:

docs.yml
1analytics:
2  fullstory:
3    org-id: ${FULLSTORY_ORG_ID} # reads your org id from environment variables
3

Provide the Org ID at publish time

The ${FULLSTORY_ORG_ID} syntax reads the value from an environment variable at publish time, so the variable must be present in whatever environment runs fern generate --docs.

When you publish with a GitHub Actions workflow, map the secret into the publish step’s env:

.github/workflows/publish-docs.yml
1- name: Publish Docs
2  env:
3    FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
4    FULLSTORY_ORG_ID: ${{ secrets.FULLSTORY_ORG_ID }}
5  run: |
6    npm install -g fern-api
7    fern generate --docs