HubEngine: Trigger

You have three trigger options in the HubEngine to initiate a synchronization plan:

• Manual
• Scheduled
• Webhook

You can find the options in the plan overview under the Trigger tab. The individual options can be combined with each other as desired. In the screenshot only manual triggering is activated.

When triggering manually, you trigger the HubEngine plan using the trigger button in the upper right corner. Here you have the option of triggering the synchronisation in two different ways:

• Trigger by IDs: With this trigger, you can synchronize individual data records based on their system IDs. To do this, enter one or more IDs (separated by commas) in the respective fields and trigger the synchronization for these data records.
• Trigger by Date Modified: This trigger synchronizes all changes that have occurred since the last trigger by date modified

With the scheduled trigger, you set up a cronjob.

“The croncommand-line utility, also known as cron job, is a job scheduler on Unix-like operating systems. Users who set up and maintain software environments use cron to schedule jobs (commands or shell scripts) to run periodically at fixed times, dates, or intervals.” – Wikipedia

By default, synchronization frequencies between every minute and yearly are available. To validate the format of your cronjob, you can use e.g. Crontab Guru. There are five parameters to specify:

Minute Hour Day Month Weekday

Examples for cronjobs

• minutely: * * * * *
• hourly: 0 * * * *
• Every day at 00:05 in August: 5 0 * 8 *
• At 16:00 on every Wednesday: 0 16 * * 3

Plans can also be triggered via webhooks. There are two possibilities here:

Trigger-URL
Action-URL

The trigger URL can only be called via a POST request, it is available as an API endpoint. This means that the plan can also be triggered via code.

The action URL can be called via an ordinary web request. The target URL determines the page to be redirected to after the action URL has been called.

The external webhooks are a follow-up action after the plan has been executed. Thus, a POST request can be sent to trigger further actions after the plan execution.

It is also possible to trigger the execution of further HubEngine plans afterwards.