Event payloads in UI Builder

  • Release version: Xanadu
  • Updated October 28, 2024
  • 1 minute to read
  • Use event payloads to link additional data to an action.

    Event payloads are pieces of data sent by a component when a selected event is triggered. The data sent by an event can include the type of event, timestamps, user actions, or resource data such as a SysID.

    You can use this payload data when configuring an event handler so that the resulting interaction can be linked to the emitted data. For example, a SysID can be passed to other components on a page to display information related to a specified record.

    Red box containing the available event payloads for the selected component.

    Each component and event has a unique set of payload options. Event payloads may not be properly defined for each component. If that is the case, define a client script so that the console logs payloads such as console.log(event.payload).