View as Markdown
Airplane icon

Airplane ACTION

Execute Runbook

Execute a runbook and receive a session ID to track the runbook's execution. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Airplane account once, then configure and run Execute Runbook 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: "airplane-execute-runbook",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    airplane: { authProvisionId: "apn_xxxxxxx" },
    id: "Runbook ID",
    slug: "Slug",
  },
})

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.

Execute Runbook inputs
Property Type Description
id Runbook ID string
Unique ID of the runbook. You can find your runbook's ID by visiting the runbook's page on Airplane. The runbook ID is located at the end of the url. e.g. the runbook ID for https://app.airplane.dev/runbooks/rbk20220120z15kl79 is rbk20220120z15kl79
Optional
slug Slug string
Unique slug of the runbook. You can find your runbook's slug next to the runbook's name within the runbook editor on Airplane. Either an ID or a slug must be provided.`
Optional
paramValues Parameter Values object
Mapping of parameter slug to value. You can find your runbooks's parameter slugs inside the runbook editor on Airplane.
Optional

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
airplane-execute-runbook
Version
0.0.3
App
Airplane
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes