API Reference flow_runner v#6.15.1
Copy MarkdownModules
Provides functions to run a Flow.
Compile-time documentation collection for FLOIP block modules.
The default blocks as per the FLOIP spec 1.0.0-rc4
A module to make it easier to create flows without needing to write the JSON manually
Compile converts a JSON flow into an internal representation that is able to be run.
A context provides information about an ongoing user flow session.
Specify the callback functions to run a Flow.
A base module from which one can implement one's custom flow runner.
A custom FLOIP block for dynamically generating the list of buttons available but at runtime.
A block to handle Meta Conversions API events.
A custom FLOIP block for scheduling the execution of a flow for some time in the future (instead of executing it immediately), or cancelling a previously scheduled flow.
A block to handle the sending of content cards from Turn
A custom FLOIP block for setting properties on a chat that is available within the current context.
A custom FLOIP block for setting properties on a message that is available within the current context
A custom FLOIP block to update a dictionary contained in the FLOIP context variables.
A Wait block type to introduce delays in Journey flows.
A custom Webhook block type for Turn's Build functionality.
A block to handle WhatsApp call permission request messages.
A block to handle WhatsApp interactive Call-to-Action (CTA) URL messages.
A block to handle WhatsApp catalog messages.
A block to handle WhatsApp request location messages.
A block to handle the sending of WhatsApp Flows.
A block to handle the sending of the WhatsApp message templates
A block to handle WhatsApp video call messages.
A block to handle WhatsApp voice call messages.
A Flow Builder DSL
A simulator for interacting with the Flow Runner.
The output of a state in simulator step
A Block is a unit of execution within a flow. It may wait for user input and provide content that should be rendered to the user.
Switch between various exit conditions.
Log things!
A type of block that sends a message to the user.
A specialisation of a block that allows users to send numeric input.
A specialisation of a block that sends users a set of options and waits for the user to come back with one of them.
Output to a Flow Result which is not yet implemented.
Implements the Core.RunFlow block type. Temporarily defers execution to a new flow.
A specialisation of a block that sends users a set of options and waits for the user to come back with one of them.
Set a contact property.
Set a group membership.
Container contains a set of flows and resources according to the Flow spec.
An exit is a potential branch off a FlowRunner.Spec.Block.
A Flow is a set of connected blocks as defined by the Flow Spec.
Languages are ISO-639-3 codes with some extra metadata
Resource stores a piece of content in various languages and modes. Usually associated with a block.
ResourceValue is a struct that stores a piece of content for a given language and mode.
A macro to help loading of JSON floip specs into structs.