DispatchWorkflow
Triggers a workflow dispatch event for the specified workflow, allowing a workflow to be run manually or from an external system.
Stored Procedure-Specific Information
The 'Inputs' parameter is a JSON string of key-value pairs matching the input parameters defined in the workflow file.
To execute this procedure, enter:
EXEC [Information].[DispatchWorkflow] Repository='myrepo', WorkflowId='289393537', Ref='main'
To include input parameters, enter:
EXEC [Information].[DispatchWorkflow] Repository='myrepo', WorkflowId='289393537', Ref='main', Inputs='{"environment":"production","debug":"false"}'
Input
| Name | Type | Required | Description |
| OwnerLogin | String | False | The owner of the repository. |
| Repository | String | True | The name of the repository. |
| WorkflowId | String | True | The ID or filename of the workflow to trigger. |
| Ref | String | True | The git reference to run the workflow on. Can be a branch name, tag name, or commit SHA. |
| Inputs | String | False | A JSON string of key-value pairs representing the input parameters defined by the workflow. |
Result Set Columns
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |