jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-08 03:01:54 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #17717 from thispsj/workflow_dispatch-webhook-info

Browse Source 
Adds description table for webhook payload object of `workflow_dispatch` webhook event
This commit is contained in:
Janice
2022-05-20 10:29:39 -07:00
committed by GitHub
parent 11eefcc010 e5c2dc8f98
commit 438a2b1c4c
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md
View File

@@ -1481,6 +1481,17 @@ This event occurs when someone triggers a workflow run on GitHub or sends a `POS
- {% data variables.product.prodname_github_apps %} must have the `contents` 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. |
{% data reusables.webhooks.org_desc %}
| `ref` | `string` | The branch ref from which the workflow was run. |
{% data reusables.webhooks.repo_desc %}
{% data reusables.webhooks.sender_desc %}
| `workflow` | `string` | Relative path to the workflow file which contains the workflow. |
### Webhook payload example
{{ webhookPayloadsForCurrentVersion.workflow_dispatch }}