GitHub RunWorkflow

GitHub RunWorkflow

Certified

Dispatch a workflow run

Triggers a workflow_dispatch event for a workflow in the target repository. The authenticated token must be allowed to read the repository and run workflows on the selected ref.

yaml
type: io.kestra.plugin.github.actions.RunWorkflow

Trigger a GitHub Action workflow manually.

yaml
id: run_github_action_workflow_flow
namespace: company.team

tasks:
  - id: run_workflow
    type: io.kestra.plugin.github.actions.RunWorkflow
    oauthToken: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
    repository: your_owner/your_repository
    workflowId: your_workflow_id
    ref: your_branch_or_tag_name
    inputs:
      foo:bar
Properties

GitHub App installation token

Installation access token generated by a GitHub App. Use this for repository-scoped app access instead of a user token.

GitHub API endpoint

GitHub or GitHub Enterprise API base URL such as https://api.github.com or https://ghe.acme.com/api/v3. Set this when targeting GitHub Enterprise or a non-default API endpoint.

Workflow inputs map

Key/value payload passed to workflow inputs. Property values are rendered before the dispatch request is sent

GitHub JWT token

GitHub App JWT used for app-level authentication. Use this when the task should authenticate as the app rather than a user.

GitHub login

GitHub login used with oauthToken for authenticated requests. Leave unset when authenticating with jwtToken or appInstallationToken.

GitHub OAuth token

GitHub personal access token used for authenticated requests. Can be used alone or with login.

Reference (ref) of the pluginDefaults to apply to this task.

Workflow ref

Branch or tag name used to resolve the workflow file. This ref must exist in the target repository.

Target repository

Repository in owner/repo format containing the workflow. The authenticated token must have access to this repository.

Workflow ID or filename

Workflow identifier accepted by the GitHub API such as a numeric ID or a workflow filename like build.yml

More Plugins in this Category

NetBox (EE)
NetBox
Enterprise

Enterprise NetBox tasks to create, update, and query devices, IP addresses, and sites over the NetBox API.

Infrastructure

7 tasks

4 blueprints

YouTube
YouTube

Tasks that interact with the YouTube Data API.

Business

4 tasks