List of flow action options
This page describes the available options in the manifest.json
file's features.flowActions
property.
tsFile
tsFile
The file path of a TypeScript file that contains the logic for one or more actions.
actions
actions
An array of one or more actions.
id
id
A GUID for the action.
name
name
A human readable name for the action. This appears in FL0's UI.
description
description
A human readable description for the action. This appears in FL0's UI.
parameterDescriptors
parameterDescriptors
An array of more parameters that users can configure after adding the action to their workflow.
displayName
displayName
A human readable name for the parameter. This appears in FL0's UI.
key
key
A unique ID for the parameter.
isRequired
isRequired
If true
, the user must provide a value for the parameter.
type
type
The type of data accepted by the parameter.
The available options include:
- String
- JsonObject
- ConditionJson
- Json
stringFormat
stringFormat
The format of the string. This is only relevant if the type
of the parameter is "string"
.
The available options include:
- SingleLine
- SingleLineWithoutEvaluation
- MultiLine
- MultiLineWithoutEvaluation
- Boolean
- Enum
- Integer
- Decimal
- Password
metadata
metadata
???
outputPathNames
outputPathNames
The names of possible execution paths. For example, a component has branching logic could have two output path names: "True"
and "False"
. Most components only need a single value in this array and it's convention to call it "Next"
.
Example
{
"tsFile": "flowActions.ts",
"actions": [
{
"id": "7139e63b-a05b-4eee-a6b5-87039437df2e",
"name": "Send To Webhook URL",
"description": "Send message to channel via Webhook URL.",
"parameterDescriptors": [
{
"displayName": "Webhook URL",
"key": "webhookUrl",
"isRequired": true,
"type": "String"
},
{
"displayName": "Message",
"key": "message",
"isRequired": true,
"type": "String"
}
],
"outputPathNames": ["Next"]
}
]
}
Updated 9 months ago