Get started with the Postman Agent Mode on Cloud

This guide explains how to set up and use the Postman Agent Mode on Cloud. It covers engineering tasks such as updating code repositories and running API tests and workflows against your Postman Collections and GitHub repos.

Once you complete the steps in this guide, you can invoke the agent from Slack and Microsoft Teams using @Postman, monitor its activity in the Postman desktop app, and review its output before merging a pull request.

Prerequisites

To use the Postman Agent Mode on Cloud, you need the following:

• Access to either a Postman-integrated Slack workspace or a Postman-integrated Microsoft Teams organization.
• A Postman account with access to the relevant workspace.
• A GitHub account connected to your Postman organization.

Authorize the Postman integration for Slack

To allow the agent to receive task instructions and post updates in Slack, you need to authorize the Postman integration for your Slack workspace.

If you haven’t connected Slack with Postman, the first time you invoke @Postman in Slack, you’ll be prompted to authorize the Postman app to access your Slack workspace.

Otherwise, click Integrations on the Postman homepage and find Slack, or follow the integration setup instructions.

When redirected to Slack’s OAuth authorization page asking you to allow the Postman app access to Slack, do the following:

1. Review the permissions that the app will be granted.
2. Select the workspace from the dropdown.
3. Click Allow to proceed.

Authorize the Postman integration for Microsoft Teams

To allow the agent to receive task instructions and post updates in Microsoft Teams, you need to install the Postman integration for Microsoft Teams.

1. Add the Postman app as a personal app in Microsoft Teams.
2. Start a 1:1 chat with the Postman app in Microsoft Teams.
3. Start the sign-in process and when redirected to the OAuth page, select a workspace, and click Allow to proceed.

The Postman app is now ready to use in Microsoft Teams. To start Postman Cloud Agent tasks from within Microsoft Teams, you can ask @Postman in a 1:1 chat with the Postman app, or in any channel or group chat.

Authorize GitHub access

GitHub access is required for the agent to interact with your code repositories, run tests, and complete workflows in your GitHub repos.

If you haven’t authorized GitHub access, the first time you invoke @Postman in Slack with a --repo flag, you’ll be prompted to authorize the Postman app to connect to your GitHub account.

Follow the sign-in prompts to authorize Postman to access your GitHub organization.

After you authorize access, your GitHub repos become available for the agent to interact with based on the task instructions you provide in Slack or Microsoft Teams.

Invoke the agent in Slack or Microsoft Teams

To start using the agent, do the following:

1. Go to the target Slack channel or Microsoft Teams chat.

2. Mention @Postman in a message to invoke the agent.

3. Give the bot natural language task instructions. Use the --repo flag to scope the task to a specific GitHub repository. For example, you can ask it the following:

   Ask what the agent can do

   @Postman what can you do?

   Fix the README

   @Postman --repo repo-name fix README

   Run API tests

   @Postman --repo repo-name run API tests

   Update code to match the collection

   @Postman --repo repo-name Update my frontend, backend, and tests to match the collection. Add a check on every pull request that updates code based on collection and API updates.

The agent starts processing and posts a progress status reply in the thread. You can click Watch Live to monitor activity in real time.

In Postman, select Home > Agent Tasks in the header to view a record of your conversations.