GitHub: Create a workflow dispatch event

← Actions operations · Get started

Operation github.actions_create_workflow_dispatch

Provider route: POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["actions"]["actionsCreateWorkflowDispatch"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.actions.actionsCreateWorkflowDispatch(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.actions.actions_create_workflow_dispatch(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.owner	string	Required within parent
path.repo	string	Required within parent
path.workflow_id	JSON	Required within parent
path.workflow_id (oneOf 1)	integer	Alternative
path.workflow_id (oneOf 2)	string	Alternative
body	object	Required within parent
body.inputs	object	Optional	Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when `inputs` are omitted. Maximum fields: 25 Additional keys: allowed
body.ref	string	Required within parent	The git reference for the workflow. The reference can be a branch or tag name.

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create a workflow dispatch event — response body

Referenced models: Create a workflow dispatch event — response body

Schemas

Create a workflow dispatch event — response body

Field	Type	Presence	Description and constraints
$	object	Root	Response containing the workflow run ID and URLs.
html_url	string	Required within parent	Format: uri
run_url	string	Required within parent	The URL to the workflow run. Format: uri
workflow_run_id	Model	Required within parent	Expand Create a workflow dispatch event — response body — workflow run id

Referenced models: Create a workflow dispatch event — response body — workflow run id

Create a workflow dispatch event — response body — workflow run id

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	integer	Alternative	The ID of the workflow run. Format: int64
$ (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: github.actions_create_workflow_dispatch. Catalog operation: actions/create-workflow-dispatch. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source