Learn the specifics of developing a Cron plugin.

Select the running environment

The first step to develop a new cron type plugin is to determine what environment is going to be used:

  • Python

  • NodeJS

Create the file structure

Set up a directory structure with the following files

├── src
│   ├── or control.js  
│   ├── or function.js
│   ├── view.xml
├── manifest.toml 

Edit control and function scripts

Fill those files with the content that you require according to the table below, then save them.

ScriptExecuted Purpose


Only once when the plugin is created

Perform one time setup tasks


Periodically according to the frequency set

Perform time-triggered tasks

Edit view.xml file

Populate this file with content based on the form you'd like displayed when creating this plugin.

Edit the LICENSE and files

Write the contents of the and LICENSE and files.

Edit the manifest.toml file

According to the cron section within the Private Plugins page, the manifest.toml should look like:

manifest_version = 2.0
version = "1.0.56" 
runtime = "nodejs:10" <- replace accordingly 
plugin_type = "cron"  <- fixed value. Don't change
license_name = "MIT license" 

interval = 1 
run_on_deploy = false

price = 0 

Compressing the files

Compress the files in zip format from the root of the file structure, not the parent folder.

Last updated