Integrate Postman with Microsoft Teams

Connect your Postman account to Microsoft Teams with the Postman app. Install the Postman app in Teams to get started.

Microsoft Teams is a platform for real-time collaboration and communication. With Postman's integrations for Microsoft Teams, you don't have to leave Teams to collaborate on API development. Share what you're working on, get notifications, and stay up to date with Postman activity, all within Teams.

Postman offers three different integrations for Teams: the Postman app, monitor notifications, and activity feed notifications. You can set up the integrations you want, or use them all to get the most out of Postman and Teams.

Connect your Postman account to Microsoft Teams

Collaborate on API development in Teams with the Postman app. You can share enhanced Postman links that you and your teammates can use to take action right in Teams. You can also find and share Postman workspaces, requests, and collections from within Teams.

Add the Postman app to Teams

Once you install the Postman app, you can find Postman elements from within Teams and share enhanced Postman links.

  1. Sign in to your Microsoft Teams account.

  2. In Microsoft Teams, select + Apps.

  3. Search for "Postman" and select the Postman app in the search results.

  4. Select Add to add the Postman app for yourself.

    You may need approval from a Teams Administrator to install apps in Teams.

  5. Select Sign in to sign in to your Postman account, then select Continue.

  6. Select Accept to give Postman permission to view your profile and content in Teams.

After installing the Postman app, Postman links that you share in Teams are automatically unfurled into rich links. Postman supports rich links for elements such as workspaces, collections, folders, requests, examples, environments, and comments. Postman also supports rich links for HTTP responses.

When you share a Postman link, Teams displays extra information such as the name and type of element and who last updated it. Also, Teams displays options to take action with the element, such as adding a comment, or watching or forking a collection.

Link unfurling isn't available for Postman links shared from personal workspaces. Change your workspace to another type of workspace to collaborate in Teams.

Teams rich links

Postman also supports rich links for HTTP responses. Teams displays extra information such as the request URL and response code when you share a Postman link. Teams displays the response body for Postman links shared from team workspaces. For links shared from private or Partner workspaces, Teams doesn't display the response body and you must open Postman to view it. Learn how to share a response.

Link unfurling for HTTP responses isn't available for Postman links shared from personal workspaces. Change your workspace to a team, private, or Partner workspace to collaborate on responses in Teams.

Teams rich links response

Links you share in Teams are pasted as text. To unfurl extra information about an element, a Postman link you share in Teams must be a hyperlink. Select Insert link at the top of the editor, add the text to display, enter the Postman link as the address, then select Insert. You can also add a space after the Postman link to make it a hyperlink.

If the element or HTTP response includes sensitive data, be aware that it might be visible to collaborators you share with in Teams. Make sure to consider the sensitivity of data when deciding which collaborators you share with. Postman recommends checking your organization's policies to understand what qualifies as sensitive data.

You can remove the preview from your message if you're concerned about the data that's shared when a link unfurls. To remove the preview from a sent message, learn about editing a sent message in Microsoft Teams.

Share Postman elements from within Teams

You can find and share Postman workspaces, collections, and requests without leaving Microsoft Teams.

  1. In Teams, start or reply to a post and select + Actions and apps.
  2. Select the Postman app.
  3. Select Workspaces, Collections, or Requests, and then start typing in the search box to find the content your want to share.
  4. Select a workspace, collection, or request to add a rich link to your post.
Share Postman elements in Teams

Send monitor and activity notifications to Microsoft Teams

Sending monitor and activity notifications are separate integrations from the Postman app. Install them from Postman, rather than from within Teams.

You can send the results of Postman Monitor runs to Teams. You can also send notifications about Postman team activity to Teams. Before configuring either integration, you must create a webhook connector in Teams.

Create a Microsoft Teams webhook URL

Microsoft Teams requires certain permissions to add a connector to a channel. Learn more about managing Microsoft 365 connectors and custom connectors.

To configure a Microsoft Teams integration, you'll first need to create a Microsoft Teams webhook URL.

  1. Sign in to your Microsoft Teams account.
  2. Create a new channel, or select an existing channel where you want to set up the integration.
  3. Select More options next to the channel name and select Manage channel.
  4. In the Connectors section, select Edit.
  5. Search for "Incoming Webhook" in the list of available connectors and select Add.
  6. Enter a name to identify this webhook later. You can also add an image that appears whenever the webhook posts a message.
  7. Select Create. This generates a webhook URL you can use to post messages to this channel.
  8. Copy the webhook and save it for later.

For more help creating an incoming webhook, see the Microsoft Teams documentation.

Send Postman Monitor results to Microsoft Teams

Send the results from a Postman Monitor run to a specified Microsoft Teams channel. Monitor run messages summarize the basic details of the run, and whether the run succeeded or failed. Each message also provides links to that run and the documentation for the collection.

To send Postman Monitor run results to Microsoft Teams, do the following:

  1. From the Postman Home page, select Integrations.

  2. Select Browse All Integrations.

  3. Search and select Microsoft Teams.

  4. Next to Post monitoring results, select Add Integration.

  5. Enter the following in the Add Integration window:

    • Nickname - A nickname for the integration.
    • Choose workspace - The workspace that has your monitor.
    • Choose Monitor - The monitor which will send its results to Microsoft Teams.
    • Notification URL - Your incoming webhook URL where your team's updates are sent.
    • Configure when monitor runs must be notified - Select whether you want notifications for all completed monitor runs, or notifications for three monitor run failures and then the first successful monitor run.
  6. Select Add Integration.

Send Postman team activity to Microsoft Teams

Send your team's activity feed to a specified Microsoft Teams channel. Team Activity messages display updates, who made a change, and what it was.

To send Postman team activity to Microsoft Teams, do the following:

  1. From the Postman Home page, select Integrations.

  2. Select Browse All Integrations.

  3. Search and select Microsoft Teams.

  4. Next to Post team activity, select Add Integration.

  5. Enter the following in the Add Integration window:

    • Nickname - A nickname for the integration.
    • Notification URL - Your incoming webhook URL where your team's updates are sent.
  6. Select Add Integration.

You can view your configured integrations on the Browse Integrations page. You can also view integrations that have been configured for a monitor by opening the monitor and selecting Info icon Info in the right sidebar. Learn more about viewing or editing integrations.

Last modified: 2024/10/02