Postman Sync

Keep your docs in sync with Postman automatically, via GitHub.

Why Postman Sync

• Real-time updates — every Postman change is reflected in Theneo.
• No manual uploads — skip exporting and re-uploading collections.
• Version control — changes are tracked through GitHub for collaboration and rollback.
• Streamlined workflow — developers build APIs while docs stay current.
• Automated publishing — with auto-publish on, your docs stay fresh hands-free.

Set up Postman → GitHub sync

Once set up, all Postman updates push automatically to your GitHub repository.

Sync GitHub updates to Theneo

To carry those updates into Theneo, configure Theneo GitHub Actions. Add a Theneo.yml file in .github/workflows/:

 
  name: Update Documentation
on:
  pull_request:
    branches:
      - main
jobs:
  update-doc:
    name: Update Theneo Documentation
    runs-on: ubuntu-latest
    steps:
      - run: echo "🎉 Triggered by a ${{ github.event_name }} event."
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "18"
      - name: Update Documentation on Theneo
        uses: Theneo-Inc/api-documentation@1.8.0
        with:
          FILE_PATH: doc/api.yml

          PROJECT_SLUG: <project_slug>
          VERSION_SLUG: <version_slug>
          WORKSPACE_SLUG: <workspace_slug>

          SECRET: ${{secrets.SECRET}}

          AUTO_PUBLISH: true

          IMPORT_OPTION: merge
          PARAMETER_DESCRIPTION_MERGE_STRATEGY: keep_new
          SECTION_DESCRIPTION_MERGE_STRATEGY: keep_old

          INCLUDE_GITHUB_METADATA: true

Replace , , and `` with your values, and add your Theneo secret to your GitHub repository secrets.

Need a visual walkthrough?

More resources

For full details on configuring Theneo GitHub Actions, see our setup guide.

Once GitHub sync is configured in Postman and the Theneo GitHub Action is set up, your Theneo documentation stays automatically in sync with your latest Postman updates.