POSTMAN BEST PRACTICES
Tool integration with your toolchain
Building quality APIs has never been more important. At Postman, we believe being API-first is the key to innovation in the AI era. We built Postman Best Practices to share the foundational ideas Postman is built on and enable you to do your best work.
When your toolchain is disconnected, specs drift out of sync with code, test failures get buried in chat threads, and debugging requires jumping between multiple systems.
This chapter introduces you to Native Git and shows you how to integrate Postman with tools in your stack, such as GitHub, Slack, Teams, and Jira, so you can stay in the flow of work without letting things slip through the cracks.

Abhinav Asthana
Postman CEO and Co-founder

Ankit Sobti
Postman Field CTO and Co-founder
API development rarely happens in isolation. Your team has already established workflows with GitHub for version control, Slack or Teams for communication, and Jira for issue tracking. But when toolchains are disconnected, API work becomes fragmented. Specs drift from code, test failures get buried in chat, and debugging requires jumping between multiple systems to piece together what went wrong.
Postman integrates directly with your existing development tools, keeping API design, testing, and collaboration synchronized with code changes, team communication, and project management. These integrations work across both app-specific APIs built for single applications and internal reusable APIs that serve multiple teams.
Git integration: Keep APIs and code in sync
When API specifications and code live in separate systems, they inevitably drift apart. Better synchronization between design and implementation can prevent teams from encountering outdated documentation, broken contracts, and integration failures.
This guide is recommended for both app-specific APIs and internal reusable APIs.

Native Git
Native Git connects the Postman desktop app directly to your local git repository, storing all Postman assets—collections, specs, environments, and mocks—as files in your /postman directory alongside your code. Learn more about Native Git in our docs.
Setup guide:
- Open the Postman desktop app and navigate to your workspace.
- Select Connect Repository from the workspace menu and authorize access to your git provider.
- Choose your local git repository root directory when prompted.
- Postman will create a
/postmandirectory and populate it with your existing workspace assets. - Commit the
/postmandirectory to your repository to begin version-controlling your Postman assets alongside code.
Development workflow:
- Create a feature branch in git before starting any API changes.
- Open the Postman desktop app—your workspace automatically reflects the checked-out branch.
- Make changes to collections, specs, and environments in Postman; changes save directly to your local filesystem.
- Commit Postman changes alongside code changes in the same pull request to keep API design and implementation synchronized.
Important: Native Git operates in Local View only. Changes to Postman assets are not synced to the Postman Cloud until you push your branch and the changes are merged to the remote repository.
Recommended practices:
- Keep your
/postmandirectory at the root of your repository so all contributors can find Postman assets alongside the code they describe. - Treat Postman asset changes like code: require PR reviews for collection and spec changes before merging.
- Store local environment values (e.g.,
base_url, API keys) in your machine's local environment and never commit sensitive values to the/postmandirectory. Learn more about managing environments in our docs.
GitHub integration
The GitHub integration connects Postman Collections to GitHub repositories via the Postman Cloud, enabling automatic backup and synchronization without requiring the Postman desktop app.
Use the GitHub integration for:
- Backing up collections to a
postman/folder in a GitHub repository on every save - Syncing collection changes to a target branch (e.g.,
mainordevelop) - Triggering CI/CD workflows via
github-actionswhen Postman collection changes are committed


Setup guide:
- Connect your GitHub repository to a Postman Collection from the workspace integrations menu.
- Select the repository, branch, and directory where collection files will be stored.
- Choose whether to sync on every save or on-demand.
- Integrate Postman CLI into your CI/CD pipeline to run collection tests on every pull request.
Recommended practices:
- Fork collections when developing new features to keep the main collection stable while iterating.
- Configure GitHub branch protection rules to require passing Postman collection tests before merging.
- Use Postman's visual diff tools to review API changes alongside code changes in pull requests.
Slack and Microsoft Teams integrations: Stay informed about API changes
Important API updates often get lost in email notifications or buried in dashboards that teams rarely check. When breaking changes go unnoticed or when developers can't quickly get help with API issues, development momentum slows and problems multiply.


This guide is recommended for both app-specific APIs and internal reusable APIs.
Implementation guide
Connect Postman workspaces to your team communication channels to surface API changes, monitor alerts, and collaboration requests where your team naturally works.
Configure workspace notifications:- Connect Postman workspaces to relevant Slack channels or Teams channels
- Set up selective notifications by choosing which workspace activities will be sent to channels
- Use workspace updates to communicate significant API changes directly to subscribed channels
- Enable consumers to stay informed by subscribing to relevant channels for APIs they depend on
- Copy and share direct links to collections, requests, responses, workspaces, comments, and other Postman elements in team channels
- Include relevant context when sharing API issues so team members can provide targeted assistance
- Enable two-way interaction where team members can respond in channels or return to Postman to collaborate directly
- Use threaded conversations to keep API discussions organized and searchable
- Configure monitor notifications to alert relevant channels when monitors are triggered, fail, or experience performance issues
- Route different types of alerts to appropriate channels (critical failures to on-call, performance issues to engineering, etc.)
- Enable personal notifications from settings to handle access requests and other actions directly via Slack
- Include actionable information in alerts so teams can respond quickly
Recommended practices
- Use dedicated channels for API updates rather than mixing with general development discussion.
- Balance visibility with noise by focusing on actionable events that require a team response.
- When sharing API issues, include collection links and relevant test results.
- Define clear procedures for acknowledging and assigning API alerts shared in team channels.

Jira integration: Connect API work to project workflows
When API development happens outside your project management system, important work becomes invisible to stakeholders, priorities get misaligned, and teams lose track of how technical work connects to business objectives.
This guide is recommended for app-specific APIs as well as internal and partner reusable APIs.

Implementation guide
Link Postman directly to your Jira projects to create seamless workflows for tracking API development, managing bug reports, and coordinating feature work.
Connect Jira projects:- Integrate Jira Cloud with Postman workspaces
- Configure project mappings to route API issues to appropriate Jira projects
- Set up custom field mappings to capture API-specific context in issue descriptions
- Generate Jira issues directly from failed API requests or unexpected responses
- Automatically include request details, response data, and environment information in issue descriptions
- Link related collections and test results to provide complete debugging context
- View Jira issue status directly in Postman request panels
- Monitor resolution progress without switching between tools
- Update issue status as API problems are identified and resolved

Recommended practices
- Create Jira issue templates for API problems that consistently capture essential debugging information.
- Establish clear criteria for API issue priority to ensure proper handling within project workflows.
- Configure Jira projects so API work is visible to both engineering and product teams.
- Use workflows that indicate when API issues are resolved and properly tested.
- Use Agent Mode to automate Jira to GitHub merges
Tip: Use Agent Mode to create Jira tickets with full API context. When an endpoint failure needs to be escalated, Agent Mode can draft a complete Jira ticket with all the debugging context in a single step. Prompt: "@POST /api/v2/refunds is returning a 501. Create a Jira ticket for the backend team with the endpoint details, the expected response schema from the OpenAPI spec, and the reproduction steps."
Ready to get hands-on? Connect a GitHub repository to your collection, set up Slack notifications, or configure Jira issue tracking.
