Skip to content






Service manager

API Explorer

Using events to trigger Flux services

Another purpose of external events is to trigger Flux services. A Flux service can be started by an external event if one of its triggers is equal to the external event. Inputs from the external event are passed as part of the execution request which will then be mapped to the Flux service's inputs. If a validation error occurs, the service won't be started.

When a Flux service is triggered by an external event, a String input named $triggerFluxEvent will be available to the service. This is used to determine which trigger was used to start the service.

To demonstrate triggering, create a Flux service that logs a message to System.out and then follow the instructions below:

Adding triggers

Adding triggers

Adding triggers

  1. Click any blank part of the canvas to show the Flux Properties view.
  2. For this example, add a trigger named invoked.

    In Coder Studio, you need to click the Triggers field in the view and then click on the button. If you're in Coder Cloud, just double click it. A dialog or modal will pop-up and prompt you to enter triggers that you want for your service.

    You can add other triggers, too. Just make sure to separate them by line.

  3. Save your file.

Triggering Flux services

  1. Open the Console tab to verify if the Flux service will be executed later.

    To do this in Coder Studio, right click on your TORO Integrate instance and then click on Open Integrate Console. In Coder Cloud, just click on the Console tab at the bottom panel; it's visible by default.

  2. Access the Send Flux Event dialog on the same menu by clicking Flux > Send Flux Event. Alternatively, you can right click on the canvas and select Send Flux Event from there.

  3. Input invoke as the event and click Send. Your service should be executed and you should see some logs on the console:

    Triggering Flux services

    Triggering Flux services

  4. This time, edit your service and log $triggerFluxEvent instead to see which trigger was used to invoke the service. Send another event when finished and you should see invoke logged on the console.

    Triggering Flux service with `$triggerFluxEvent`

    Triggering Flux service with `$triggerFluxEvent`