Scheduling

Job Scheduling

Since hotglue syncs data via asynchronous jobs, it is often optimal to configure a sync schedule that is used to automatically trigger jobs on a certain interval.

hotglue leverages UNIX cron expressions to offer flexible scheduling expressions. For example, the following expression would trigger every day at 12:00am UTC:

cron(0 0 * * *)

How to configure the sync schedule

Admin Panel

To configure a sync schedule via the admin API, first navigate to the desired tenant.

From here, open the relevant flow you wish to schedule and open the sync schedule drawer.

From here you can configure the desired sync schedule, and press Save. If done correctly, you will see the status change to enabled.

API

To configure a sync schedule via the API, head to the schedule endpoint docs.

Using a default sync schedule

Alternatively, you can also configure a default sync schedule for each flow. The default sync schedule is automatically enabled when a tenant links a source.

📘

The default sync schedule will not apply to any tenants that have already linked a source. The schedule (and any changes) only apply when tenants link a source.

To configure the default sync schedule, you will first need to enable the Automatically enable default sync schedule environment setting:

Automatically enable default sync schedule settingAutomatically enable default sync schedule setting

Automatically enable default sync schedule setting

Once this setting is configured, open the flow you wish to add a default sync schedule for and open the Sync Schedule drawer

🚧

Make sure you're in the admin view when setting a default schedule, or it will not apply properly.

In the schedule editor, configure your desired sync frequency, and Save. You should see the status set to enabled if it is enabled correctly.

📘

If you'd like to apply a more granular default sync schedule using a cron expression, use the API

That's it! Now when users link the configured flow, your default sync schedule will automatically apply!


Did this page help you?