- Introduction
- 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
- 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 your 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
- Billing
- Configuring team settings
- Utilizing audit logs
- Onboarding checklist
- Migrating data between teams
- 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
Creating Run in Postman buttons
One way to share your Postman Collections is to create a stand-alone Run in Postman button. You can embed the button in your website or a README to let developers interact with your API more quickly.
The Run in Postman button also works with API specification formats like OpenAPI and RAML. To create a button for the standard you use, first convert the file to a collection by importing it into Postman or by authoring your specification in Postman to generate a collection.
Contents
Creating a Run in Postman button
Make sure you're signed in to your Postman account, and that you have a collection to share.
- In the Postman app, open the collection you want to share.
- Next to the collection name, expand the collection details and click the Share button to open a modal.
- Tab over to Embed.
- Click Generate code.
-
Choose a dynamic or static button:
- Dynamic button: This button uses JavaScript, HTML and CSS, so you can customize the button for a website. You can also access the Run in Postman API to dynamically create and update environments.
- Static button: This button uses Markdown, so you can display it in a README, blog, or other Markdown document.
- You can optionally include an environment to embed with your collection. On the right, click the Environment drop-down and choose the environment.
- Click Copy to clipboard.
- Embed the code where you would like the button to be displayed.
Your embed code will include your collection's ID. In the examples below, :collection_id
is a placeholder for that ID. If you choose to include an environment in your button, the code will also have the environment parameter.
Sample markdown snippet:
[](https://www.postman.com/run-collection/:collection_id)
Sample HTML snippet:
<div class="postman-run-button"
data-postman-action="collection/import"
data-postman-var-1=":collection_id"></div>
<script type="text/javascript">
(function (p,o,s,t,m,a,n) {
!p[s] && (p[s] = function () { (p[t] || (p[t] = [])).push(arguments); });
!o.getElementById(s+t) && o.getElementsByTagName("head")[0].appendChild((
(n = o.createElement("script")),
(n.id = s+t), (n.async = 1), (n.src = m), n
));
}(window, document, "_pm", "PostmanRunObject", "https://run.pstmn.io/button.js"));
</script>
You can include an environment along with a collection in your Run in Postman button. The dynamic button gives you access to the Run in Postman API to create and modify environments.
Keeping your collections up to date
When you make changes to a collection that's shared with a Run in Postman button, you'll need to manually update the button's collection link so that your users import the most recent version of your collection.
- In the Postman app, open the original collection.
- Next to the collection name, expand the collection details and click the Share button to open a modal.
- Tab over to Embed > Update link.
The collection imported by users is a copy of the original, so updates made to the original are not updated in these copies. Users must import the latest collection to see updates made to the original collection.
Next steps
Read more about the Run in Postman API and learn how to add and update environments with your button.