@alasdair/api-builder-plugin-invoke-flow NPM

@alasdair/api-builder-plugin-invoke-flow

This is a plugin for API Builder that provides a event flow-trigger that is used to Invoke flows and return their response.

This is a plugin to let flows invoke other reusable flows from the API Builder flow editor.

Installation

You can install this plugin into an existing API Builder project. Follow the Getting Started Guide to create an API Builder service if you do not already have one.

$ npm install @alasdair/api-builder-plugin-invoke-flow

Usage

When you install this plugin, you get a Flow listener flow-trigger, and two flow-nodes: Invoke flow and Flow listener response.

Flow listener provides a interface for your reusable Flow. Flows which have this listener must make use of the Flow listener response Flow-nodes in order to define what the flow will return or end with. Flow listener should be configured with a unique ID which can be used by any number of Invoke flow flow-nodes to call this flow and wait for the response. Flow listener outputs Data which can be provided as a Flow input. This Data is provided by calls to Invoke flow.

To make a reusable Flow, you will need to first drag a Flow listener onto your flow. If your Flow requires input data, configure your Flow Inputs to assign $.request (Data) from the flow-trigger to one of the available Flow parameters. You should also assign your Flow listener with a unique Flow listener ID.

Drag one or more Flow response flow-nodes onto your Flow where the flow should be returning, and configure it with any data to return, and if the response is an error. This will determine which output of the Invoke flow flow-node gets called.

To finish, save your flow, and in another flow drag the Invoke flow flow-node and configure it with the Flow listener ID and data required to invoke the reusable flow.