Postman API NetworkPublish to the Postman API NetworkPublish your public APIsAdd Run in Postman button

Create a Run in Postman button for your API consumers

View as Markdown

Create a Run in Postman button to enable users to instantly fork your Postman Collections into their workspaces. You can embed the button in your website or a README to enable developers to interact with your API.

Important

The Run in Postman button is only available for collections containing HTTP requests.

Active Run in Postman buttons are automatically updated with any changes in the original collection. This provides your consumers with the most recent version of your collection, without publishers having to manually update the collection’s link. For example, you can click the following Run in Postman button to fork the most recent version of the Postman API collection:

Run in Postman

To create a Run in Postman button, your collection must be in a public workspace. If it isn’t, you’ll need to change the workspace visibility to public or move the collection to a public workspace.

Note

You can also create a Run in Postman button from API specification formats like OpenAPI and RAML. First, convert the file to a collection by importing it into Postman, or by generating a collection from your API in Spec Hub.

Create a Run in Postman button

To create a Run in Postman button, do the following:

  1. In the Postman header, open the navigation menu. Then, click Published icon Public API Network.

  2. In the bottom-left corner, click Add icon Create New. Then, click Run icon Run in Postman button.

  3. Choose a collection and (optional) environment.

  4. Click Next.

  5. Choose an embed code format that’s HTML or Markdown friendly:

    • HTML friendly — This embed code uses JavaScript, HTML, and CSS, so you can customize the button for a website. You can customize the embed code to dynamically create and update environments and add environment variables to a user’s workspace.

    • Markdown friendly — This embed code uses Markdown, so you can display it in a README, blog, or other Markdown document.

  6. Click Copy icon Copy Code.

  7. Embed the code where you’d like to display the button, such as your organization’s public API documentation.

Tip

In a public workspace, you can also open a collection and click Options icon View more actions > Share. Then, click Options icon View more actions > Run in Postman.

Use a Run in Postman button

Click the Run in Postman button to open the page where you can fork the collection to your workspace. Forking the collection into your workspace lets you contribute to the source collection using pull requests.

You can also view the collection in a public workspace and import a copy of the collection using the provided links. All collections shared with Run in Postman buttons come with fork counts that help you and your consumers understand how developers use the API.

Published Run in Postman buttons are automatically updated with changes in the original collection. This enables your consumers to always get the most recent version of your collection, without publishers having to manually update the collection’s link.