Product configuration signals

A Product Configuration represents any interaction with a product that suggests that the user is preparing to add the product to their cart.

Examples include, but are not limited to:

  • Selecting a size and/ or color
  • Assigning a shipping postal code
  • Completing customization fields, such as for engraving or personalization

Configuration

Required fields

FieldValuesDefinition
categoryString. Valid value - BehaviorThe category of the signal.
nameString The name assigned to the signal. Can contain specific information about the signal that differentiates it from other signals.
signalTypeString. For product configuration signals, use
productConfiguration.
The type of signal being sent.
productIdStringIdentifier of the product
productNameStringName of the product
configurationTypeStringType of configuration that happened

Optional fields

FieldValuesDefinition
effectString. Valid values:

- negative
- positive
Describes the effect of the signal on engagement. It is intended to be used for engagement index scoring.
signalCustomAttributesArray of objectsAllows for custom attributes that are not predefined by the product. For each custom attribute, add an object with name and value.

Sample payload

{
  "signalType": "productConfiguration",
  "name": "productConfiguration from product page",
  "category": "Behavior",
  "productId": "03456889",
  "productName": "Today is a good day framed poster",
  "configurationType": "dimension change",
  "effect": "positive"
}

All data in the SDK payload must be collected manually, there is no automatic binding from the values in the page to the payload fields.