There are two ways to run your Jobs:

  1. Triggering a test Run
  2. Triggering your Job for real

1. Triggering a test Run

You can perform a Run with any payload you want or use one of our examples on the test page in our dashboard.

How to do a test Run from the dashboard.

2. Triggering your Job for real

Triggering your Job for real depends on the type of trigger you have attached to your Job.

There are three types of Trigger:

Scheduled Trigger

Scheduled Triggers do not trigger Jobs in the DEV Environment. When you're working locally you should use the Test feature to trigger any scheduled Jobs.

Scheduled Triggers are triggered automatically by our system on the schedule you define. Once you have deployed your Job, it will run automatically.

Event Trigger

Event Triggers are triggered by an event that you send from elsewhere in your code.

There are two way to send an event that will trigger eventTrigger():

  1. Use client.sendEvent() from anywhere in your codebase.
  2. Use io.sendEvent() from inside a Job's run() function.

Webhook Trigger

Webhook Triggers are triggered when you perform the action that the webhook subscribes to. For example, if you have a webhook Trigger that subscribes to the pull_request event on GitHub, then it will be triggered whenever a pull request is opened, closed, or updated on the repo you configured.