View as Markdown
GitHub icon

GitHub ACTION

Disable Workflow

Disables a workflow and sets the state of the workflow to disabled_manually. See the documentation
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's GitHub account once, then configure and run Disable Workflow 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: "github-disable-workflow",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    github: { authProvisionId: "apn_xxxxxxx" },
    repoFullname: "Repository",
    workflowId: "Workflow 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.

Disable Workflow inputs
Property Type Description
repoFullname Repository string
The name of the repository (not case sensitive). The format should be owner/repo (for example, PipedreamHQ/pipedream).
Required Dynamic
workflowId Workflow Id string
The Id of the workflow.
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
github-disable-workflow
Version
0.0.10
App
GitHub
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes