From 61300f22fb2f2852c3a54f6ee9bc98645f60d823 Mon Sep 17 00:00:00 2001 From: PSJ <51746608+thispsj@users.noreply.github.com> Date: Mon, 9 May 2022 09:52:20 +0530 Subject: [PATCH 1/2] Add desc table for `workflow_dispatch` payload --- .../webhooks/webhook-events-and-payloads.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index c0e70736bb..5b9a62c9f0 100644 --- a/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -1483,6 +1483,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 resuables.webhooks.sender_desc %} +| `workflow` | `string` | Relative path to the workflow file which contains the workflow. | + ### Webhook payload example {{ webhookPayloadsForCurrentVersion.workflow_dispatch }} From 0e0f0f3e80ff131b5c05062531c4451a68e1c317 Mon Sep 17 00:00:00 2001 From: PSJ <51746608+thispsj@users.noreply.github.com> Date: Mon, 9 May 2022 11:14:03 +0530 Subject: [PATCH 2/2] Fix typo --- .../webhooks-and-events/webhooks/webhook-events-and-payloads.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index 5b9a62c9f0..3f18cde91d 100644 --- a/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -1491,7 +1491,7 @@ This event occurs when someone triggers a workflow run on GitHub or sends a `POS {% data reusables.webhooks.org_desc %} | `ref` | `string` | The branch ref from which the workflow was run. | {% data reusables.webhooks.repo_desc %} -{% data resuables.webhooks.sender_desc %} +{% data reusables.webhooks.sender_desc %} | `workflow` | `string` | Relative path to the workflow file which contains the workflow. | ### Webhook payload example