GitHub App icon

GitHub App

Consume GitHub API using GitHub App authentication

Actions36

Workflow → Dispatch and Wait for Completion

AI-generated

Overview

This node operation dispatches a GitHub Actions workflow event and waits for its completion by pausing execution until a webhook is called. It is useful for automating CI/CD pipelines or other GitHub workflows where subsequent steps depend on the completion of a dispatched workflow. For example, you can trigger a deployment workflow and wait for it to finish before continuing with further automation.

Use Case Examples

  1. Trigger a GitHub Actions workflow in a repository and wait for it to complete before proceeding with the next steps in your automation.
  2. Dispatch a workflow that runs tests on your code and pause the execution until the test results are available via a webhook.

Properties

Name Meaning
webhookNotice Notice that execution will pause until a webhook is called, and the webhook URL will be passed to the GitHub workflow as a resumeUrl input.
owner The owner of the GitHub repository, which can be selected from a list, provided as a URL, or entered by name.
repository The name of the GitHub repository, selectable from a list, provided as a URL, or entered by name.
workflowId The GitHub Actions workflow to dispatch, selectable by list, file name, or ID.
ref The git reference (branch, tag, or commit SHA) for the workflow dispatch.
inputs A JSON object containing input parameters for the workflow.

Output

JSON

  • json - The JSON response from the GitHub API or error messages if the operation fails.

Dependencies

  • GitHub API
  • GitHub App authentication with API key credentials

Troubleshooting

  • Invalid JSON in inputs will cause an error; ensure the inputs parameter is valid JSON.
  • A 404 error indicates the specified workflow could not be found; verify the workflow ID or file name is correct.
  • If the webhook is not called, the execution will remain paused indefinitely; ensure the GitHub workflow calls the provided resumeUrl webhook.

Links

Discussion