@fimwise-trigger/fimwise-task
v1.0.0
Published
`@fimwise-trigger/fimwise-task` is a Node.js module that provides a task trigger for the Fimwise Bot platform.
Downloads
3
Readme
@fimwise-trigger/fimwise-task
@fimwise-trigger/fimwise-task
is a Node.js module that provides a task trigger for the Fimwise Bot platform.
This trigger is used to poll for tasks from the Fimwise service and execute them.
Usage
Define trigger in process configuration
To use this trigger, you need to define it in the process configuration file.
The trigger name should be @fimwise-trigger/fimwise-task
.
{
"name": "sample-process",
"triggers": [
{
"name": "@fimwise-trigger/fimwise-task"
}
]
}
Install the package
To install the package, run:
fimwise-bot install path/to/process.json
This command will also install all the dependencies required by the process which also includes the
@fimwise-trigger/fimwise-task
package.
Configuration
This trigger supports the following configuration options:
pollInterval
: The interval in milliseconds at which the trigger should poll for tasks. Default is5000
.credentials
: The credentials required to authenticate with the Fimwise service. This is optional if you already have acredentials.json
file of the Fimwise service in the root directory of the process.clientId
: The client ID.secretKey
: The secret key.
License
This project is licensed under the MIT License.