Run a specific workflow in background
The Workflows API allows you to trigger a workflow to run in the background. This endpoint is useful for running workflows on a schedule or when an event occurs. Once the Workflow Run is created, it will run asynchronously and you will receive a response immediately.
The workflow run is generated in the background. You can check the status of the workflow run by polling the Get a Workflow Run endpoint.
Your unique API key for authentication.
This key is required in the header of all API requests, to authenticate your account and access Draft & Goal’s services. Get your API key from the Draft & Goal Studio.
The ID of the workflow you want to run.
An object containing the input parameters for the workflow. Each key in this object represents an input node ID from your workflow.
You can obtain the input node IDs from the Workflow Builder input settings in the Draft & Goal Studio.
Inputs is required. To run a workflow without inputs parameters, you can pass an empty object.
Whether the workflow run was successful.
The data returned by the workflow run start.