DocumentationExperience PlatformData Collection

subscribeRulesetItems

Last update: Thu Jul 31 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer

The subscribeRulesetItems command allows you to subscribe to propositions that are the result of satisfied rulesets. You can do this by specifying which surfaces and schemas to filter by, and providing a callback function.

Any time rulesets are evaluated, the callback function receives a result object with an array of propositions within it.

IMPORTANT
The subscribeRulesetItems command is the only way to get propositions that come from rulesets, since they are not returned alongside sendEvent results.
alloy("subscribeRulesetItems", {
  surfaces: ["web://example.com/#welcome"],
  schemas: ["https://ns.adobe.com/personalization/message/content-card"],
  callback: (result, collectEvent) => {
    const { propositions = [] } = result;
    renderMyPropositions(propositions);
    collectEvent("display", propositions);
  },
});

The above code subscribes to the web://example.com/#welcome surface for content cards and uses the collectEvent convenience method to emit display events for all propositions.

Comand options command-options

This command takes an options object with the following properties:

Property
Type
Description
surfaces
String array
A list of surfaces. Propositions will only be received by the callback function if they match one of the surfaces provided here.
schemas
String array
A list of schemas. Propositions will only be received by the callback function if they match one of the schemas provided here.
callback
Function
A callback function that will be invoked when propositions are the result of satisfied rulesets. The callback function receives two parameters when invoked: result and collectEvent. See callback parameters for details.

Callback parameters callback-parameters

The callback function receives the two parameters described in the table below when invoked.

Parameter
Type
Description
result
Object
This object contains a propositions array. These propositions are the direct result of satisfied rulesets. The result object is structured the same as the result object returned by sendEvent using a then clause.
collectEvent
Function
A convenience function which you can use to send Edge Network events to track interactions, displays and other events.

collectEvent function collectevent-function

The collectEvent function is a convenience function which you can use to send Edge Network events to track interactions, displays and other events. It accepts the two parameters described in the table below.

Parameter
Type
Description
Event type
String
A string indicating which proposition event type to emit. Supported event types are display, interact, or dismiss.
propositions
Array
An array of propositions corresponding to the event.

Subscribe to content cards using the Web SDK tag extension

The Web SDK tag extension equivalent to command responses is a rule that subscribes to the Subscribe ruleset items event. The event allows you to provide the desired schemas and surfaces.

recommendation-more-help
1ae86b30-e55e-49c1-ab11-9d0356a5f3e1