1. Tasks
  2. Heimdall Register

Tasks

Heimdall Register

The Heimdall Register task registers a trigger action.

Heimdall Paths and Mechanisms form the basis of the registration task and are explained further in the Heimdall documentation.

Basic usage

Register a task to update the subject of a stub everytime a customer balance is updated,

loading...

Parameters

uuid

required
string

The unique identifier of linked to this particular Heimdall registration.


registration_name

required
string

The human readable name of the registration. This is used to identify the registration.


on_trigger_method

optional
sting

The method to use when the trigger is fired. Allows the user to specify whether to keep or remove the registration when the trigger is fired.

Options: keep | remove


events.[event_name].path

required
string

This is the path that will be monitored for triggers. * can be used as a wildcard in the path.

See also: Heimdall


events.[event_name].mechanism

required
string
The mechanism to use to fire the trigger.

Options: evt | cbh| rra| rnd| evb

Mechanism Description
evt Event
cbh Callback Handler
rra Round Robin Approach
rnd Random
evb Event Back

See also: Heimdall


events.[event_name].timeout_seconds

required
integer

The number of seconds that the registration will be active for. After this time the registration will be removed.


trigger_stubaction.action_name

required
string

The name of the stub action to trigger when the registration is fired.


trigger_stubaction.stubref

required
string

The stubref of the stub to trigger the action on.


trigger_stubaction.data

required
object

The data to pass to the stub action when it is triggered.


trigger_stubaction.message

required
string

The stub post message to pass to the stub action when it is triggered.

Result

loading...

Examples

These are some more complex examples

Send an minutely update to a stub

Task
loading...

See also: Heimdall: Standard Emitters