Invoke Route

Invoke another route of the same workflow with custom HTTP method, body, headers, and query parameters

Use it in a workflow

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

routeIdstringrequired

Select the route to invoke

methodstringrequired

The HTTP method to use when calling the route

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 route against the workflow's default published instance instead of the calling workflow's environment.

Default false

Call this workflow's own 'Validate Order' route before continuing, forwarding the order id

json

{
  "routeId": "validate-order",
  "method": "POST",
  "body": "{\"orderId\": \"{{trigger.body.orderId}}\"}"
}

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

Was this page helpful?