> ## Documentation Index
> Fetch the complete documentation index at: https://docs.r28.ai/charter/llms.txt
> Use this file to discover all available pages before exploring further.

# actions_create_workflow_dispatch

> Trigger a workflow by hand on a branch or tag. The workflow file must declare the `workflow_dispatch` trigger itself. GitHub answers with no body unless `return_run_details` is set, so set it to learn which run started.

<div className="tool-route"><span className="tool-row-method" data-method="POST">POST</span><code>{"https://api.github.com/repos/{owner}/{repo}/actions/workflows/{workflowId}/dispatches"}</code></div>

```python github_actions_create_workflow_dispatch.py theme={null}
from charter.packs import github

result = await github.actions_create_workflow_dispatch.ainvoke({"owner": ..., "repo": ..., "workflowId": ..., "ref": ...})
```

<Note>
  Requires `repo`, `read:user`.
</Note>

## Path parameters

<div className="reference-table">
  | Field                                                              | Type                  | Description                                                                                                                        |
  | ------------------------------------------------------------------ | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
  | `owner` <span className="required" title="required">\*</span>      | `string`              | The account owner of the repository. The name is not case sensitive.                                                               |
  | `repo` <span className="required" title="required">\*</span>       | `string`              | The name of the repository without the `.git` extension. The name is not case sensitive.                                           |
  | `workflowId` <span className="required" title="required">\*</span> | `integer` \| `string` | The ID of the workflow. You can also pass the workflow file name as a string, such as `ci.yml`, which is usually the one you have. |
</div>

## Body

<div className="reference-table">
  | Field                                                       | Type                                                  | Description                                                                                                                                                                                   |
  | ----------------------------------------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `ref` <span className="required" title="required">\*</span> | `string`                                              | The git reference for the workflow. The reference can be a branch or tag name.                                                                                                                |
  | `inputs`                                                    | map of `string` \| `integer` \| `number` \| `boolean` | 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. |
  | `returnRunDetails`                                          | `boolean`                                             | Whether the response should include the workflow run ID and URLs. Absent, GitHub answers 204 with no body at all, and the run you just started has to be found by listing runs.               |
</div>