Flows
Actions in the category "Flows".
Call another flow
Runs another flow synchronously (its trigger must be a manual trigger). Parameters declared by the target appear as typed argument inputs; declared return values become outputs of this step.
Inputs
| Name | Type | Required | Details |
|---|---|---|---|
| Target flow | Flow | Yes | Flow to run. Parameters declared by its manual trigger appear here as typed arguments; its return values become outputs of this step. |
Schedule flow run
Schedules another flow to run once at a specific time. Scheduled runs are persisted and survive restarts; parameters declared by the target appear as typed argument inputs.
Inputs
| Name | Type | Required | Details |
|---|---|---|---|
| Run at | Date and time | Yes | When to run the target flow. |
| Target flow | Flow | Yes | Flow to run. Its trigger must be a scheduled run trigger; parameters it declares appear here as typed arguments. |
Outputs
| Name | Type | Details |
|---|---|---|
| Run ID | Text | Handle for the scheduled run. Keep it (in storage, for example) to cancel the run later with "Cancel scheduled flow run". |
Cancel scheduled flow run
Cancels a scheduled run that has not happened yet, using the run ID that "Schedule flow run" returned. Both the stored run and its pending timer are removed, so it can no longer fire.
Inputs
| Name | Type | Required | Details |
|---|---|---|---|
| Run ID | Text | Yes | Handle returned by "Schedule flow run" or listed by "List scheduled flow runs". Length: 1 to 64 characters. |
Outputs
| Name | Type | Details |
|---|---|---|
| Cancelled | Yes/No | True if a pending run was cancelled. False (not an error) if it had already run, was already cancelled, or was scheduled outside this module or server. |
List scheduled flow runs
Returns the runs scheduled by this module or server that have not happened yet, soonest first, including runs scheduled by another flow. The arguments stored with each run are not returned.
Inputs
| Name | Type | Required | Details |
|---|---|---|---|
| Target flow | Flow | No | Only list runs of this flow. Leave empty to list every scheduled run. |
| Limit | Whole number | Yes | Maximum number of scheduled runs to return (soonest first). Value: 1 to 5000. Default: 25. |
Outputs
| Name | Type | Details |
|---|---|---|
| Scheduled runs | List of Scheduled run | Runs that have not happened yet, soonest first. |
Emit custom event
Emits a named custom event in this server. Any flow with a "Custom event received" trigger matching the same event name runs as a separate execution. Use it to fan work out between flows.
Inputs
| Name | Type | Required | Details |
|---|---|---|---|
| Event name | Text | Yes | Name of the event to emit. Flows listening for this exact name will run. Length: 1 to 100 characters. |
| Payload | Lookup table of Text to Text | No | Optional data to pass along. If this server or module declares a payload type for the event, the data must match it. Otherwise it is sent as text key and value pairs and non-text values are dropped. |
Get flow run count
Returns how many times a flow has run, as recorded in the execution history. Only runs still inside the retention window (the newest 1000, up to 30 days) are counted.
Inputs
| Name | Type | Required | Details |
|---|---|---|---|
| Flow | Flow | No | Flow to count runs for. Leave empty for the current flow. |
| Window | Time window | Yes | Restrict the count to a trailing time window, or count all recorded runs. Default: All time. |
Outputs
| Name | Type | Details |
|---|---|---|
| Count | Whole number | Number of recorded runs within the window. |
Get execution history
Returns the most recent recorded executions of a flow (newest first), each with its number, status, timestamp and trigger. Limited to the retention window (the newest 1000, up to 30 days).
Inputs
| Name | Type | Required | Details |
|---|---|---|---|
| Flow | Flow | No | Flow to read history for. Leave empty for the current flow. |
| Limit | Whole number | Yes | Maximum number of executions to return (newest first). Value: 1 to 1000. Default: 10. |
Outputs
| Name | Type | Details |
|---|---|---|
| Executions | List of Execution summary | Recent executions, newest first. |
Get flow cooldown
Reads a flow's remaining trigger cooldown. Careful: a flow can never use this to gate its own run - its window opens the moment the run is admitted, so it always reads as active. Use it to tell someone else how long to wait, or point it at another flow. The cooldown's scope (user, channel or server) is the one set on the trigger; after the flow resumes from a wait, the reading is server-wide instead.
Inputs
| Name | Type | Required | Details |
|---|---|---|---|
| Flow | Flow | No | Flow to read the cooldown of. Leave empty for the current flow. |
Outputs
| Name | Type | Details |
|---|---|---|
| On cooldown | Yes/No | True while the cooldown window is still open. During this flow's own run it is almost always true, because the window opened when the run was admitted. |
| Retry after | Duration | Remaining time until the cooldown ends (0 when none is active or the trigger has no cooldown). During this flow's own run it is close to the full cooldown, for the same reason. |
Return from flow
Ends this flow and hands the declared return values back to the calling flow. Only usable when the trigger declares return values; values left empty are returned empty.