Skip to main content

github.github.onworkflowdispatch

Home > @runlightyear/github > GitHub > onWorkflowDispatch

GitHub.onWorkflowDispatch() method​

This event occurs when a GitHub Actions workflow is manually triggered.

For activity relating to workflow runs, use the workflow_run event.

Signature:
static onWorkflowDispatch(props: GitHubListenerProps<WorkflowDispatchPayload>): {
        webhook: string;
        action: string;
    };

Parameters​

ParameterTypeDescription
propsGitHubListenerProps<WorkflowDispatchPayload>
Returns:

{ webhook: string; action: string; }