Skip to main content

Run Workflow

POST 
/run/workflow

This endpoint runs a workflow that uses a Webhook Trigger. Note that this endpoint should not be used to invoke a workflow that has a Custom Event. If you have defined a custom JSON body for the webhook trigger, it should be passed into the data body parameter.

Request​

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Body

    workflowName string

    The name of the workflow to run.

    workflowId string

    The Id of the workflow to activate. If you pass this parameter, then workflowName is not required.

    userId stringrequired

    The Id of the user you want to lookup. Returned from the Create User endpoint. Note: you can also use the Embedded user's username in this field.

    data jsonrequired

    The key-value pairs you want to send as defined in the webhook trigger. This data will be used in expressions during the workflow execution.

Responses​

200

Schema

    message string
Loading...