Postman Sync

Theneo supports automatic synchronization with Postman collections via GitHub. This powerful integration ensures that any changes you make to your Postman API collections are seamlessly updated in your Theneo documentation—without manual effort.

By setting up a GitHub integration in Postman and configuring a Theneo GitHub Action workflow, you can keep your API documentation fully aligned with your latest API definitions.

Benefits of Postman Sync

• Real-time Updates: Every change you make in Postman is reflected in Theneo.
• No Manual Uploads: Eliminate the need to manually export and upload collections.
• Version Control: Changes are tracked through GitHub, enabling better collaboration and rollback capability.
• Streamlined Workflow: Developers can focus on building APIs while keeping docs always up-to-date.
• Automated Publishing: With auto-publish enabled, your docs stay fresh without extra steps.

How to Set Up Postman to GitHub Sync

After completing this setup, all updates made in Postman will be automatically pushed to your GitHub repository.

Syncing GitHub Updates with Theneo

To ensure updates also sync to Theneo automatically, you'll need to configure Theneo GitHub Actions in your repository.

Create a Workflow File

Add a file named Theneo.yml in the .github/workflows/ directory of your GitHub repo.

Here’s an example workflow file:

 
name: Update Documentation
on:
  pull_request:
    branches:
      - main
jobs:
  update-doc:
    name: Update Theneo Documentation
    runs-on: ubuntu-latest
    steps:
      - run: echo "🎉 The job was automatically 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

Need help setting this up visually?

👉 Here is the video guide for more guidance:

More Resources

For complete details on how to configure Theneo GitHub Actions, visit our setup guide here.

Once you've successfully configured GitHub sync in Postman and set up the Theneo GitHub Action workflow, your API documentation in Theneo will stay automatically in sync with your latest Postman updates.