Skip to content

ConnectorTimerTemplate

Type: Object

A TimerTemplate is a component of a Connector that will be turned into a Timer upon installation. Timers check for new data or events at a given schedule. They are responsible for periodically querying the connected system or service to retrieve any new data or events that have occurred since the last poll.

A Connector can have multiple Timers, each with its own schedule and configuration. This allows for fine-grained control over the frequency and scope of data retrieval.

Any required configuration options should be defined in the Connector's configuration options.

Fields

NameTypeArgsDescriptionDeprecated
functionTemplateString!The Lua script to run whenever the scheduled interval becomes due.

See the Lua documentation for details of how this works. | | | name | String | | A name to refer to the Timer by, aids in human comprehension | | | schedule | String | | The schedule that the poller should run on, expressed in CRON syntax. | |

Connect. Combine. Collaborate.
The pioneering open integration platform, dedicated to transforming connectivity in the printing industry.