View as Markdown
GitHub icon

GitHub ACTION

Run Workflow

Trigger a GitHub Actions workflow run, or re-run the failed jobs of a previous run. To start a new run, provide workflow (the workflow file name, e.g. ci.yml, its display name, or its numeric ID) and optionally ref (the branch or tag to run on — defaults to the repository's default branch) and inputs (for workflow_dispatch workflows). To re-run only the failed jobs of an existing run instead, provide rerunFailedRunId. The workflow must already have a workflow_dispatch trigger to be dispatchable. Use List Workflows to find the workflow file name and List Workflow Runs to find a run ID. Provide the repository as an owner/repo string. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

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

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 Workflow inputs
Property Type Description
repoFullname Repository string
The repository in owner/repo format, for example PipedreamHQ/pipedream (not case sensitive). If you pass just a repository name with no owner (e.g. my-repo), the authenticated user is assumed as the owner — convenient for "my repo" requests. Do NOT repeat the repository name as the owner (e.g. my-repo/my-repo); if you don't know the owner, pass only the name or run List Repositories to find it.
Required
workflow Workflow string
The workflow to dispatch — its file name (e.g. ci.yml), display name, or numeric ID. Required unless re-running failed jobs. Use List Workflows to discover available workflows.
Optional
ref Ref string
The branch or tag to run the workflow on, e.g. main. Defaults to the repository's default branch.
Optional
inputs Inputs object
Input keys and values configured in the workflow's workflow_dispatch definition (max 10). Defaults from the workflow file are used for omitted inputs.
Optional
rerunFailedRunId Re-run Failed Run ID string
Provide a workflow run ID here to re-run only its failed jobs instead of dispatching a new run. Use List Workflow Runs to find a run ID.
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
github-run-workflow
Version
0.0.3
App
GitHub
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes