Data an event provides
  • 23 Aug 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Data an event provides

  • Dark
    Light
  • PDF

Article Summary

When working with events, you can see the data available for use when selecting an event type in the trigger editor dialog.

1.png

The entirety of the data contained within the event is called the payload. This refers to the information you have access to in your event handler. The information on the object which originated the event is called the origin of the event.

The information inside the payload varies depending on the event types: an Autobots > Entry added event, for example, contains extra information about the ID of the entry that was added, the example inputs, etc; a Run configuration > Execution complete event will contain information on the robot that owns the execution that was completed, as well as the data contained in the resulting rows.

You can see the data available for the event type of your choice on the left-hand side of the trigger editor dialog. The available variables and their type are listed.

Common variables
Some data is always available in the payload irrespective of the event type selected:
2.png

  • accountId
    The ID of the account where this event was triggered. This will always be the ID of your account.
  • eventType
    The type of event that was triggered, aka, the code name of the event being handled
  • origin.id
    The ID of the object which triggered the event
  • origin.name
    The name of the object which triggered the event
  • origin.type
    The type of object which triggered the event
  • origin.pathName
    The path of the object which triggered the event

Dynamic data
Some of the data available for use depends on the object for which the triggers are being configured. For example, for data set, dictionary entry and robot execution events, the rows object will contain the variables in the structure of the origin object.

In the following example, a rows added event is being added to a data set object. The payload variables available in the rows object reflect the variables of the data set itself.

3.png


Was this article helpful?