Connect your Postman account to Microsoft Teams

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

Collaborate on API development in Microsoft 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 connect a Postman workspace to Teams to get notified about team activity and communicate workspace updates.

Add the Postman app to Teams

Once you install the Postman app, you can attach Postman elements to posts without leaving Teams and share enhanced Postman links.

1. Sign in to your Microsoft Teams account.

2. In Microsoft Teams, click + Apps.

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

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

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

5. When prompted how you want to use the app, select Use on your own.

6. Click Sign in to sign in to your Postman account, then click Continue.

7. Click Accept to give Postman permission to view your profile and content in Teams.

Only Postman links shared from the account you sign in with will unfurl in Teams. To sign in with a different Postman account, click View more apps in Teams and select the Postman app. In the chat, enter "sign out". Then enter "sign in" to sign in with the Postman account you want to use.

Unfurl Postman links and take action 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 workspaces restricted only to you. Change access to your workspace to collaborate in Teams.

Share rich links for HTTP responses

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 workspaces restricted only to you. Change access to your workspace to collaborate on responses in Teams.

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 click + 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.

Connect a Postman workspace to Teams

You can connect a Postman workspace to a Microsoft Teams channel. Once you connect the two, Postman sends updates to the Teams channel when someone posts a workspace update, or adds, edits, or deletes a request, collection, or environment. Each update in Teams includes options to take actions, such as adding a comment or watching a collection.

You can connect internal workspaces to Teams. You can't connect other types of Postman workspaces. Learn more about changing workspace visibility. Also, the Teams channel you are connecting to must be a standard channel that's in a public or private Team.

To connect a Postman workspace to Microsoft Teams, do the following:

1. If you haven't already done so, add the Postman app to Teams.

2. In Microsoft Teams, click + Apps.

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

4. Click Open.

5. Under Or use with others, search for and select the channel you want to send updates to. Then click Go.

6. You're automatically redirected to the Teams channel you selected. On the Postman message card, click Connect.

7. Configure the integration with Postman:

   • Select the Postman workspace you want to send updates from. Start typing in the box to search, then select the workspace when it appears in the list.

     You can also select the workspace by pasting the workspace URL in the box. To get the URL, in Postman, select the workspace name in the sidebar. Then, in the workbench, select Copy link to workspace.

   • Select the notifications you want to get in Teams. You can get notifications when someone adds, edits, or deletes a request, collection, or environment in your Postman workspace.

   

8. Click Connect.

   A message card confirms that you connected a Postman workspace to this channel and shows the updates you'll get in Teams. If you want to change which updates to send to Teams, click Manage notifications.

Change the notifications Postman sends to Teams

You can make changes to the connection between a Postman workspace and Teams. In the connected Teams channel, enter "@Postman" and select Notifications from the list.

You can change the Postman workspace or the notifications you want to get in Teams. Click Save to update the integration.

To remove the connection between the Postman workspace and Teams, click Disconnect. You can add the connection again later if you want.

Remove the Postman app for Teams

If you no longer want to use the Postman app for Microsoft Teams, you can remove it from Teams.

1. In Microsoft Teams, click + Apps.
2. Click Manage your apps.
3. Select the Postman app, then click Remove.