View as Markdown
Postman icon

Postman ACTION

Run Monitor

Run a specific monitor in Postman. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Postman account once, then configure and run Run Monitor from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "postman-run-monitor",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    postman: { authProvisionId: "apn_xxxxxxx" },
    monitorId: "Monitor ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Run Monitor inputs
Property Type Description
monitorId Monitor ID string
The ID of the monitor to run.
Required Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
postman-run-monitor
Version
0.0.2
App
Postman
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes