Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Directly dispatch a GitHub Actions workflow and get its run ID.
github.dispatchWorkflow directly starts a workflow configured for workflow_dispatch and returns the created run identity.
import { automation } from "automate.ax"
import { github } from "automate.ax/github"
export default automation("Deploy through GitHub", () => {
const run = github.dispatchWorkflow({
inputs: { environment: "production", version: "2.0.0" },
owner: "SentsCo",
ref: "main",
repository: "automate.ax",
workflowId: "deploy.yml",
})
})
ref. Optional inputs must match the workflow’s declared inputs; GitHub accepts at most 25 properties. Returns workflow_run_id, run_url, and html_url, so you can correlate the exact run without searching by timestamp. Requires Actions write permission.