workflow_dispatch
This event occurs when someone triggers a workflow run on GitHub or sends a POST request to the “Create a workflow dispatch event” endpoint. For more information, see “Events that trigger workflows”
Availability
- GitHub Apps must have the content permission to receive this webhook
Webhook payload object
| Key | Type | Description |
|---|---|---|
| inputs | object | Inputs to the workflow. Each key represents the name of the input while it's value represents the value of that input. |
| organization | object | Webhook payloads contain the organization object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization |
| ref | string | The branch ref from which the workflow was run. |
| repository | object | The repository where the event occurred |
| sender | object | The user that triggered the event |
| workflow | string | Relative path to the workflow file which contains the workflow |
Webhook payload example
{
"inputs": {
"name": "Mona the Octocat"
},
"organization": {
"avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
"description": null,
"events_url": "https://api.github.com/orgs/octo-org/events",
"hooks_url": "https://api.github.com/orgs/octo-org/hooks",
"id": 79927191,
"issues_url": "https://api.github.com/orgs/octo-org/issues",
"login": "octo-org",
"members_url": "https://api.github.com/orgs/octo-org/members{/member}",
"node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI",
"public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}",
"repos_url": "https://api.github.com/orgs/octo-org/repos",
"url": "https://api.github.com/orgs/octo-org"
},
"ref": "refs/heads/main",
"repository": {
"allow_forking": true,
"archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}",
"archived": false,
"assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}",
"blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}",
"branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}",
"clone_url": "https://github.com/octo-org/octo-repo.git",
"collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}",
"comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}",
"commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}",
"compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}",
"contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}",
"contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors",
"created_at": "2021-08-16T21:34:28Z",
"default_branch": "main",
"deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments",
"description": null,
"disabled": false,
"downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads",
"events_url": "https://api.github.com/repos/octo-org/octo-repo/events",
"fork": false,
"forks": 1,
"forks_count": 1,
"forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks",
"full_name": "octo-org/octo-repo",
"git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}",
"git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}",
"git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}",
"git_url": "git://github.com/octo-org/octo-repo.git",
"has_downloads": true,
"has_issues": true,
"has_pages": false,
"has_projects": true,
"has_wiki": true,
"homepage": null,
"hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks",
"html_url": "https://github.com/octo-org/octo-repo",
"id": 6811672,
"is_template": false,
"issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}",
"issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}",
"issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}",
"keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}",
"labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}",
"language": null,
"languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages",
"license": null,
"merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges",
"milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}",
"mirror_url": null,
"name": "octo-repo",
"node_id": "MDEwOlJlcG9zaXRvcnkzOTY5ODA4MTI=",
"notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}",
"open_issues": 97,
"open_issues_count": 97,
"owner": {
"avatar_url": "https://avatars.githubusercontent.com/u/6811672?v=4",
"events_url": "https://api.github.com/users/octo-org/events{/privacy}",
"followers_url": "https://api.github.com/users/octo-org/followers",
"following_url": "https://api.github.com/users/octo-org/following{/other_user}",
"gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/octo-org",
"id": 79927191,
"login": "octo-org",
"node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI9",
"organizations_url": "https://api.github.com/users/octo-org/orgs",
"received_events_url": "https://api.github.com/users/octo-org/received_events",
"repos_url": "https://api.github.com/users/octo-org/repos",
"site_admin": false,
"starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octo-org/subscriptions",
"type": "Organization",
"url": "https://api.github.com/users/octo-org"
},
"private": false,
"pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}",
"pushed_at": "2022-01-07T21:57:21Z",
"releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}",
"size": 144,
"ssh_url": "[email protected]:octo-org/octo-repo.git",
"stargazers_count": 0,
"stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers",
"statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}",
"subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers",
"subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription",
"svn_url": "https://github.com/octo-org/octo-repo",
"tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags",
"teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams",
"topics": [],
"trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}",
"updated_at": "2022-01-07T21:57:24Z",
"url": "https://api.github.com/repos/octo-org/octo-repo",
"visibility": "public",
"watchers": 0,
"watchers_count": 0
},
"sender": {
"avatar_url": "https://avatars.githubusercontent.com/u/25328854?v=4",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"gravatar_id": "",
"html_url": "https://github.com/octocat",
"id": 25328754,
"login": "octocat",
"node_id": "MDQ6VXNlcjI1MzI4ODU0",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"repos_url": "https://api.github.com/users/octocat/repos",
"site_admin": true,
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"type": "User",
"url": "https://api.github.com/users/octocat"
},
"workflow": ".github/workflows/hello-world-workflow.yml"
}