Launching flows
Flows can be launched the following ways.
From the Flow editor by pressing the Run button
From an API call.
Calling from outside Ziggy with an API call
Making an API call is the most common way to launch a Flow for integrations. Some event happens in an external system that should then launch the Flow.
Make a POST request to the /ziggy/execute-external endpoint.
https://mydomain.com?flowUuid=6f8dcd90-8b89-420d-a59d-4bbb46a98f1a&isDebug=false&isStep=false&executionEnvironmentMode=DEV
Ziggy has an API endpoint that listens for flow executions.
Copy request to clipboard
Copy a Flow's execution URL to the endpoint from the Flow Settings dialog by pressing the URL button.
Request details
Data you want to pass to the Flow is provided in the request body. This data is placed on Receiver Block's output edge.
All other parameters are specified as query parameters, namely
Parameter | Description |
|---|---|
| The Flow's id |
| DEV | PROD defaults to DEV if omitted |
| Set to 'true' if you want the Flow to run in debug mode. |
| Set to 'true' if you want the Flow to run in debug:step mode. |
| Extra information that helps you uniquely identify the request. Can be referenced as ```externalExecutionId``` from the Javascript Block or other Utility Block fields where tokens can be specified. |
Headers
The following headers should be set.
Header name | Description |
|---|---|
| application/json |
| The execution token, which is configured in Global Settings -> Security |
Response
Ziggy returns one of the following status codes.
201- OK400- Fatal Flow error408- Timed out410- Flow not found500- Internal Ziggy error
Successful requests will return the Flow's Terminator data, if set in the Terminator, otherwise the string "OK".