Invoke Workflow

Invoke another workflow with custom HTTP method, path, body, headers, and query parameters

Use it in a workflow

Add a step and choose the Invoke Workflow connector.
Pick the Invoke Workflow action (under workflow).
Fill in the fields below, then reference the result from later steps as {{invokeWorkflow.response.data}}.

Fields

workflowSlugstring

Enter the slug of the workflow to invoke

methodstringrequired

The HTTP method to use when calling the workflow

One ofGETPOSTPUTPATCHDELETEDefault "POST"

pathstring

The path to use for the workflow request (e.g., /api/users/123)

Default "/"

forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers will override incoming headers.

Default false

headerskeyvalue

HTTP headers to include in the request

queryParamskeyvalue

URL query parameters to include in the request

bodystring

JSON body to send with the request (for POST, PUT, PATCH methods)

excludeEnvironmentboolean

Run the target workflow against its default published instance instead of the calling workflow's environment.

Default false

Examples

Trigger a nested workflow

Invoke a 'send-welcome-email' workflow, forwarding the new customer's email and name in the body

json

{
  "workflowSlug": "send-welcome-email",
  "method": "POST",
  "path": "/notify",
  "body": "{\"email\": \"{{trigger.body.email}}\", \"firstName\": \"{{trigger.body.firstName}}\"}"
}

Need more? See the Invoke Workflow guide for connection setup and behaviour shared by every action.

Was this page helpful?