Action types for web extensions

In the context of data collection tags, an action is something that is performed after a rule event has occurred and all conditions have passed evaluation.

As an example, an extension could provide a “show support chat” action type which could display a support chat dialog to help users who may be struggling while checking out.

This document covers how to define action types for a web extension in Adobe Experience Platform.

Action types typically consist of the following:

1. A view shown within the Experience Platform UI and Data Collection UI that allows users to modify settings for the action.
2. A library module emitted within the tag runtime library to interpret the settings and perform an action.

module.exports = function(settings) {
  alert('Thanks for visiting our site!');
};

For example, to make the message configurable by the Adobe Experience Platform user, you could allow the user to input and save a message to the settings object. The object looking something like this:

{
  "message": "Thank you for being one of our VIP members!"
}

In order to operate on the user-defined message, your module would need to change to this:

module.exports = function(settings) {
  alert(settings.message);
}

Contextual event data

A second argument would then have to be passed to your module which contains the contextual information about the event that fires the rule. It may be beneficial in certain cases and can be accessed as follows:

module.exports = function(settings, event) {
  // event contains information regarding the event that fired the rule
};

The event object must contain the following properties:

The extension providing the event type that triggered the rule may optionally add any other useful information to this event object.