Onboarding Checklist

If you're just getting started using Postman within your organization, you can carry out a few preparation steps to set your team up for success.

Contents

Setting up Postman

Make sure everyone who uses Postman has the latest version by downloading it from the Postman website. You may want to contact your IT team to establish what the procedure is for adding a new piece of software. This varies from organization to organization, however, the following points are common:

  • Your IT team may need to add an exception to device policy allowing for Postman to be installed on employee workstations. Provide a Postman download link​ to the IT team to help establish this exception.
  • If your organization's network connection is facilitated via a proxy, you may need to configure Postman appropriately. Retrieve proxy connection details from your IT team and ​setup within Postman​.
  • It is recommended that your IT team whitelist Postman’s domains to ensure Postman data is synced with the cloud and all functionality works as expected. By default, WebSocket connections use the same ports as HTTP (80) and HTTPS (443). Ensure your network firewall allows WebSocket connections for Postman's services by whitelisting the following domains:

    • *.postman.com
    • *.getpostman.com
    • *.postman.co
    • *.pstmn.io
  • Depending on your plan static IP addresses may be available for Postman Monitors. Your IT team should whitelist these static IPs for monitoring. Currently, static IPs are available only for the US east and US west regions. If you selected a Static IP region on your monitors, you will have to whitelist the following IP addresses:

    • 34.201.186.27 for US - east
    • 52.89.173.88 for US - west
  • Update your team settings. See Team Settings for more info.
  • If your Postman plan includes single-sign-on (SSO) you may need help from your IT team to configure it. See Configuring SSO for a team for instructions on integrating with specific identity providers.

Invite Team Members

Depending on the size of your team you can send invites to your team now or Check Your Setup with a few volunteers before you rollout Postman to your entre organization.

You can add your teammates from your team dashboard, by generating a shareable link, or inviting them through a direct email. See Managing Your Team for more detail.

Invite Users

Check Your Setup

Before you kick-off in full, it’s best to check-in on the workings of the Postman app within your organization and ensure everything works as expected. If you do not have the Postman app and Postman account find a team member who does to help you test the configuration. Depending on your organization's IT policy you may need to make requests of your IT team in order to get up and running as well.

Ensure you are connected to your organization's network and test the following:

  • Can you ​execute a request​ to example.com within Postman?
  • Can you execute a request to one of your internal/private APIs?
  • Save a request inside a ​Collection​. Visit ​go.postman.co​, has your collection and request synced with Postman’s cloud?

Repeat these checks on a colleague’s workstation. If everything worked, your workstations and network are ready to support Postman! Else, if you experienced a hiccup, ​contact Postman support and please read on.

Enable Team Discovery

Team discovery makes Postman’s collaboration features more discoverable to users, and allows your team participation to scale up along with your successful API projects. When team discovery is enabled, users in your organization can see teams to join when they access their Postman accounts. Anyone signing in with a company email address is presented with available teams and can make a request to join each one. Administrators will receive a notification and can approve or deny access from there. See Team Discovery for more info.

Questions?

If you have any questions or run into any issues setting up Postman for your team be sure and check to see if the question has already been answered by the Postman Community. You can also find a number of support resources on the support page.

Next Steps

Check out Security and Compliance: A Shared Responsibility Model for important security considerations.

Make sure to configure SSO if you are subscribed to the Business or Enterprise plan.

Finally, head over to Managing Your Team to learn about managing roles, inviting to workspaces, and how to adjust your team size.