Access custom code contextual information

When a placement executes custom code as an experience or a trigger executes a Custom Code action, you can access the payload object containing contextual information related to the event that triggered the code execution. This payload allows you to employ relevant data to customize the user experience, enhance analytics, and perform other functions based on the event details.

Common Use Cases

Retrieve contextual information

Follow these steps to retrieve contextual information:

1. In the custom code block in your JWX dashboard, add the following code.
   
   Be sure to replace the <PROPERTY> placeholder with the payload property to be retrieved.

   JavaScript

   console.log(payload.<PROPERTY>);

   
   

2. Use the value of the property within the custom code.

payload reference

payload: {
  placementId: "abcd1234",
  analytics: {
    embedId: "cd3e43f3",
    evaluationId: "j4hncv8a",
    outcomeId: "kn349ng3"
  },
  eventEmitter: {<various>},
  eventEmitterType: {<various>},
  eventPayload: {<various>}
}

analytics