{ "opencollection": "1.0.0", "info": { "name": "Github Dispatch API", "version": "1.1.4" }, "items": [ { "info": { "name": "Dispatch", "type": "folder" }, "items": [ { "info": { "name": "GitHub Create Workflow Dispatch Event", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/repos/:owner/:repo/actions/workflows/:workflow_id/dispatches", "headers": [ { "name": "Authorization", "value": "example_value" }, { "name": "X-GitHub-Api-Version", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ], "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." }, { "name": "workflow_id", "value": "", "type": "path", "description": "The ID of the workflow. You can also pass the workflow file name as a string." } ], "body": { "type": "json", "data": "{}" } }, "docs": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workf" }, { "info": { "name": "GitHub Create Repository Dispatch Event", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{hostname}/repos/:owner/:repo/dispatches", "headers": [ { "name": "Authorization", "value": "example_value" }, { "name": "X-GitHub-Api-Version", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ], "params": [ { "name": "owner", "value": "", "type": "path", "description": "The account owner of the repository. The name is not case sensitive." }, { "name": "repo", "value": "", "type": "path", "description": "The name of the repository without the `.git` extension. The name is not case sensitive." } ], "body": { "type": "json", "data": "{}" } }, "docs": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#repository_dispa" } ] } ], "bundled": true }