Updating content

Automatic re-indexing

We automatically re-index all content every 24 hours. We calculate differences in content and update all downstream dependencies as needed.

Update with a webhook call

To update content on-demand, you can make an API call to Inkeep's management service that will trigger a source synchronization job. This is useful for content that has a CI/CD pipeline or for CMS systems that offer webhooks when content changes. Contact us for a management API key and guidance on how to set this up.

Update with a GitHub Action

You can set up a GitHub Action workflow to automatically trigger Inkeep to re-crawl a source that corresponds to a (public or private) GitHub repo. This way of triggering indexing is possible for publicly available web content managed via Git, like documentation or marketing sites.

name: Sync Inkeep Source
 
on:
  push:
    branches:
      - main
 
jobs:
  syncSourceJob:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
 
    steps:
    - name: Checkout
      uses: actions/checkout@v3
      
    - name: Sync Source
      uses: inkeep/pr-commenter-action@v10
      env:
        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
      with:
        apiKey: ${{secrets.INKEEP_API_KEY}}
        sourceId: "{SOURCE_ID}"

name: Inkeep Source Sync
 
on:
  push:
    branches:
      - main
    paths:
      - "docs/**"
 
jobs:
  syncSourceJob:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
 
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Check for changes
        uses: dorny/paths-filter@v2
        id: changes
        with:
          filters: |
            docs:
              - 'docs/**'
      - name: Sync Source
        if: steps.changes.outputs.docs == 'true'
        uses: inkeep/pr-commenter-action@v10
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
        with:
          apiKey: ${{secrets.INKEEP_API_KEY}}
          sourceId: "{SOURCE_ID}"

How it Works

• The workflow is triggered whenever changes are pushed to the main branch and there are changes in the matching paths. Note that this only happens when a PR is merged or push is made to the target branch.

• If the push to main is associated with a pull request, a comment will be added to the PR confirming that an ingestion job was triggered:

  :mag_right: :speech_balloon: Inkeep AI search and chat service is syncing content for source '{Source-Name}'

• The new content will be ingested within 1 hour.

Permissions