- Installing and updating
- Navigating Postman
- Sending your first request
- Managing your account
- Syncing your work
- Discovering templates
- Creating your first collection
- Creating a workspace
- Setting up your Postman app
- Importing and exporting data
- Troubleshooting app issues
- Building requests
- Authorizing requests
- Receiving responses
- Grouping requests in collections
- Using variables
- Managing environments
- Visualizing responses
- Specifying examples
- Using cookies
- Working with certificates
- Generating client code
- Troubleshooting requests
- Scripting in Postman
- Writing pre-request scripts
- Writing tests
- Using the Collection Runner
- Scheduling runs with monitors
- Building request workflows
- Importing data files
- Working with your team
- Defining roles
- Requesting access
- Sharing your work
- Your private API network
- Commenting on collections
- Versioning APIs
- Using version control
- Using the API Builder
- Managing and sharing APIs
- Validating APIs
- Monitoring APIs
- Setting up a monitor
- Viewing monitor results
- Monitoring APIs and websites
- Set up integrations to receive alerts
- Running Postman monitors using static IPs
- Troubleshooting monitors
- Monitoring FAQs
- Analyzing with reports
- Documenting your API
- Authoring your docs
- Publishing your docs
- Viewing documentation
- Using custom domains
- Publishing templates
- Publishing to the API Network
- Submission guidelines
- Managing your team
- Purchasing Postman
- Configuring team settings
- Utilizing audit logs
- Onboarding checklist
- Intro to SSO
- Configuring SSO for a team
- Logging in to an SSO team
- Microsoft AD FS
- Custom SAML in Azure AD
- Custom SAML in Duo
- Custom SAML in GSuite
- Custom SAML in Okta
- Custom SAML in Onelogin
- Custom SAML in Ping Identity
- Migrating to the current version of Postman
- Developing with Postman utilities
- Postman API
- Echo API
- Collection SDK
- Postman Runtime library
- Code generator library
- Postman Collection conversion
Postman allows you to back up your collections (for paid plans only) or synchronize your APIs schemas on GitHub. For each of these integrations, you'll need to generate a GitHub personal access token.
- Troubleshooting GitHub Sync
In order to set up an integration, you will need a GitHub Personal Access Token.
Log in to GitHub.
If you don’t already have a Personal Access Token from GitHub, generate a new one.
For backing up your collections, select the
repo and the
user scope. For syncing your API schema, select only the
You can back up and sync your Postman collections with a GitHub repo. Once the integration is complete, any new changes to your collection in Postman will also appear in the repository.
Backing up collections on GitHub is available for Team, Business and Enterprise plans only.
In the Integrations tab for your workspace, select Github from the list of third party Integrations.
Click View Details to see information about Github and how it can back up your Postman Collections to your designated repositories.
You also can click the Configured Integrations tab to set up other integrations, view available integrations for Github, or view all integrations.
The above screen provides you the following two options:
- Backup your Postman Collections to GitHub
- Backup your Postman Collections to GitHub on a custom domain
Click Add Integration to authorize a backup of your Postman collections, then enter your GitHub Personal Access Token and click the Proceed button.
Once the token is verified, you'll be able to configure the integration.
- Select a collection to back up.
- Select the repository.
- Enter the directory where the collection will be pushed. If the directory does not exist, it will be created for you. If you do not specify anything, the default directory will be
- Enter the file name of the collection in the repository.
- Enter the branch where the collection will be pushed. This branch should already exist in your repository. If you do not specify anything, it will be pushed to the default branch of the repository.
To finish, click Add Integration.
Every change saved to your Postman Collection automatically commits changes to your GitHub repo in real time. Your Collections and code can live together in perfect harmony in the same repository.
Enter your GitHub Personal Access Token, specify your GitHub custom domain and click Proceed. In Backup your Postman Collections, choose an existing Postman collection, specifying your GitHub repository, a filename for your backup, and your chosen branch name.
Click Add Integration. Your collection is pushed to your GitHub project under the directory that you specified and saved as a single JSON file. This is illustrated in the following screen:
Now every change that is saved to your Postman Collection automatically commits changes to your GitHub repository in real time. Your collections and code can exist in the same repository.
You can navigate to your GitHub repository to view your collections.
Syncing your API schemas will enable a two-way sync between the schema stored in the GitHub repository and the schema on Postman.
Navigate to the web dashboard, select the appropriate workspace, then Integrations at the top. On the integrations page, click Create an integration in this workspace, search for the GitHub tile and click View Details. On the next page, click + Add Integration next to Sync API schema.
For a new API, click APIs in the app sidebar, then click + New API at the top. Once the API is created, choose Select from repository in the dropdown.
For an existing API, navigate to your API by clicking APIs in the app sidebar, select your API from the list, then click Connect Repository to start configuring the integration.
Enter your personal access token in the text field, select I consent to Postman collecting and storing my GitHub Access Token, then click Proceed. On the next page, select the API you want to sync with GitHub, and the GitHub repository where the schema should sync from the dropdowns, then click Add Integration and Continue.
The list of your GitHub repositories may take some time to load.
On the next page you need to setup your webhook. To do so, go to the settings page of your GitHub repository, click Webhooks, then Add webhook. Copy over the
Payload URL and
Secret from Postman, then click Add webhook to confirm. Refer to the GitHub documentation for more detail.
Once your webhook is set up, go back to the Postman dashboard, click Add API Version, and select the following details:
- the API Version you want to sync - e.g.
- the repository branch to use - e.g.
the repository directory where you want the schema file to be saved - e.g.
- Leaving this field blank will save the schema at the root of your repository. If the folder specified doesn't exist on the repository it will be created.
the name and extension of the schema file - e.g.
- If the file doesn't exist on the repository it will be created.
To finish, click Add API Version
You can sync multiple API versions by clicking Add API Version again. To delete an existing API version, hover over the entry, click the grey X to the right, then click Remove API Version.
If you are linking an existing API schema on Postman to an existing schema file on GitHub, a pop-up message will appear asking which schema you want to keep. The other schema will be overwritten.
Once the integration is complete, return to the Postman app and navigate to your API. The Connect Repository should show the path and name of the schema file on your GitHub repository - e.g.
After your first schema sync, each change to the schema in Postman will appear in the repository as a new commit. Similarly, if you or someone else updates the file on the GitHub repository, the API schema on Postman will be updated.
If changes take place on the repository while you are editing the file on Postman, a Conflict state will be displayed. Saving the changes on Postman will override the file on GitHub.
If you're having issues with your GitHub integration and find your data isn't syncing to GitHub, please ensure that the following requirements are in place:
- The GitHub integration has been added to the same workspace as the content you're trying to push to the GitHub repo.
- The correct option has been chosen when setting up your integration and selecting Backup your Postman Collections to GitHub, for example if you're using a custom domain.
- Your repo has been initialized with a
Readme.mdfile. Check the box Initialize this repository with a README and then configure a new integration on it.
- The scopes
repoare selected when creating the access token on GitHub.
- The branch specified in the setup already exists on Github. The integration will not create one if the branch doesn't exist.
- You have permissions to push to the branch.
- If all else fails, try reinstalling the integration.
If your enterprise version of GitHub is on-prem / self-hosted, this may be a firewall issue.