Events for Web

The user has added a product to the cart.

Parameters

• name: Human-readable name, not used to identify an event type.
• properties: A container for the event properties as specified in the table below.

JavaScript Example (Web)

DY.API("event", {
  name: "Add to Cart",
  properties: {
    dyType: "add-to-cart-v1",
    value: 59.13,
    currency: "any supported currency code",
    productId: "item-34454",
    quantity: 1,
    size: "XL",
    cart: [{
        productId: "sku-4324-bg",
        quantity: 2,
        itemPrice: 12.34,
      },
      {
        productId: "item-34454",
        quantity: 1,
        itemPrice: 59.13
      }
    ]
  }
});

The user has added a product to their Wishlist.

Parameters

• name: Human-readable name, not used to identify an event type.
• properties: A container for the event properties as specified in the table below.

JavaScript Example (Web)

DY.API("event", {
  name: "Add to Wishlist",
  properties: {
    dyType: "add-to-wishlist-v1",
    productId: "item-34454",
    size: "XL"
  }
});

The user has changed an attribute of the displayed product (e.g. color, fit).

Parameters

• name: Human-readable name, not used to identify an event type.
• properties: A container for the event properties as specified in the table below.

Note: the attribute type and value should match the product feed. The currently displayed product is inferred from the in-page context.

JavaScript Example (Web)

DY.API("event", {
  name: "Change Attribute",
  properties: {
    dyType: "change-attr-v1",
    attributeType: "Color",
    attributeValue: "Navy Blue"
  }
});

The user has filtered the product list by a specific field value.

Parameters

• name: Human-readable name, not used to identify an event type.
• properties: A container for the event properties as specified in the table below.

Example

DY.API("event", {
  name: "Filter Items",
  properties: {
    dyType: "filter-items-v1",
    filterType: "Color", // Name of filter (Color, Size, Brand, Fit, Author, Keyword, Category...)
    filterNumericValue: 4
  }
});

Aside from the predefined Event schemas above, visitors can be identified at any other relevant instance during their journey (e.g. within the checkout process) by calling the following Identify API.

DY.API("identify", {
  uid: "c0e93cee791b35af528a825f6476e8108e5f03e481ee39800a31a75559cdba2e", //SHA 256 hashed email of the plain text email in lower case
  type: "he"
});

• Advanced users only
• Adds an identification method to the current user
• The identification can be later used by advanced users to connect with their own Business Intelligence systems

The user has run a free-style keyword search.

Parameters

• name: Human-readable name, not used to identify an event type
• properties: A container for the event properties as specified in the table below.

JavaScript Example (Web)

DY.API("event", {
  name: "Keyword Search",
  properties: {
    dyType: "keyword-search-v1",
    keywords: "my search string"
  }
});

The user has logged-in. It is recommended that the login event will also establish “user identification” (i.e. associating a customer ID with Dynamic Yield’s own user ID). Passing an e-mail as the user ID is usually preferable, as you’ll later be able to use Dynamic Yield’s email capabilities for that user. However, any other ID type is supported, including multiple ID types per user.

If the users’ email addresses are used as their unique identifier across the site and within the onboarded CRM data, then the “hashedEmail” field should be filled with SHA256(to_lower_case_(email)) encoded email address. If a custom identifier is used, then it should be passed in the “cuid” and “cuidType” (e.g. “webId” or “customerId”), instead of the “hashedEmail” field.

You have a few choices of what to include when sending this event:

1. Send the event with just a hashed e-mail.
2. Send the event with just a non-email CUID (Customer User ID). In this case, you may decide to explicitly specify the type by also setting the “cuidType” property. If cuidType is not set, a default type named “id” is used.
3. Send both an e-mail AND a non-email identifier. In this case, both will be linked with each other.

Parameters

• name: Human-readable name, not used to identify an event type
• properties: A container for the event properties as specified in the table below.

JavaScript Examples (Web)

DY.API("event", {
  name: "Login",
  properties: {
    dyType: "login-v1",
    hashedEmail: "...", // SHA256 encoding of the lowercase e-mail, if known (optional)
  }
});


DY.API("event", {
  name: "Login",
  properties: {
    dyType: "login-v1",
    cuid: "...", // If not identifying by e-mail, pass the customer ID (optional)
    cuidType: "..." // If not identifying by e-mail, pass the customer ID type (optional)
  }
});

Mark individual user emails to receive or not receive triggered emails. The email recipient list is managed by Dynamic Yield using these events.

Message Opt-In Parameters

• name: Human-readable name, not used to identify an event type
• properties: A container for the event properties as specified in the table below.

JavaScript Examples (Web)

DY.API("event", {
  name: "message opt in",
  properties: {
    dyType: "message-optin-v1",
    cuidType: "email", //can be "external" or "email"
    plainTextEmail: "REPLACE_WITH_EMAIL_ADDRESS", //mandatory valid plain text email address if cuidType is "email"
  }
});

DY.API("event", {
  name: "message opt in",
  properties: {
    dyType: "message-optin-v1",
    cuidType: "external", //can be "external" or "email"
    externalId: "[REPLACE_WITH_EXTERNAL_ID]", //mandatory if you cuidType is "external"
  }
});

Message Opt-Out Parameters

• name: Human-readable name, not used to identify an event type
• properties: A container for the event properties as specified in the table below.

JavaScript Examples (Web)

DY.API("event", {
  name: "message opt out",
  properties: {
    dyType: "message-optout-v1",
    cuidType: "email", //can be "external" or "he"
    hashedEmail: "REPLACE_WITH_EMAIL_ADDRESS", //mandatory valid hashed email address if cuidType is "he"
  }
});


DY.API("event", {
  name: "message opt out",
  properties: {
    dyType: "message-optout-v1",
    cuidType: "external", //can be "external" or "he"
    externalId: "[REPLACE_WITH_EXTERNAL_ID]", //mandatory if you cuidType is "external"
  }
});

The user has subscribed to a newsletter.

Parameters

• name: Human-readable name, not used to identify an event type
• properties: A container for the event properties as specified in the table below.

JavaScript Example (Web)

DY.API("event", {
  name: "Newsletter Subscription",
  properties: {
    dyType: "newsletter-subscription-v1",
    hashedEmail: "..." // SHA256 encoding of the lowercase e-mail,
    // in textual hexadecimal representation
  }
});

The user has entered a valid promo code.

Parameters

• name: Human-readable name, not used to identify an event type
• properties: A container for the event properties as specified in the table below.

JavaScript Example (Web)

DY.API("event", {
  name: "Promo Code Entered",
  properties: {
    dyType: "enter-promo-code-v1",
    code: "..."
  }
});

The user has made a purchase.

Parameters

• name: Human-readable name, not used to identify an event type
• properties: A container for the event properties as specified in the table below.

JavaScript Example (Web)

DY.API("event", {
  name: "Purchase", // Human-readable name, not used to identify an event type
  properties: {
    uniqueTransactionId: "123456", // Will remove redundant events. Must be a string. Max 64 characters.
    dyType: "purchase-v1", // Identifies this event as a purchase
    value: 90.55, // Total cart value in actual payment currency, as float (dollars dot cents)
    currency: "any supported currency code", // Optional non-default currency used
    cart: [
      // itemPrice is per quantity of one, and in the same format as the total "value":
      // float of dollars.cents in the payment currency (which is only defined once above)
      {
        productId: "item-34454", // SKU exactly as in the product feed!
        quantity: 1,
        itemPrice: 65.87,
        size: "XL" // Size is *optional and a customer-specific string*
      }, {
        productId: "sku-4324-bg",
        quantity: 2,
        itemPrice: 12.34,
        size: "M"
      }
    ]
  }
});

The user has removed a product from the cart.

Parameters

• name: Human-readable name, not used to identify an event type
• properties: A container for the event properties as specified in the table below.

JavaScript Example (Web)

DY.API("event", {
  name: "Remove from Cart",
  properties: {
    dyType: "remove-from-cart-v1",
    value: 34.45,
    currency: "any supported currency code",
    productId: "gswefd-34-454",
    quantity: 1,
    size: "XL"
    cart: [{
        productId: "sku-4324-bg",
        quantity: 2,
        itemPrice: 12.34,
      },
      {
        productId: "item-34454",
        quantity: 1,
        itemPrice: 34.45
      }
    ]
  }
});

Trigger an event when the user has completed the sign-up process.You have a few choices of what to include when sending this event:

1. Send the event with just a hashed e-mail.
2. Send the event with just a non-email CUID (Customer User ID). In this case, you may decide to explicitly specify the type by also setting the “cuidType” property. If cuidType is not set, a default type named “id” is used.
3. Send both an e-mail AND a non-email identifier. In this case, both will be linked with each other.

Parameters

• name: Human-readable name, not used to identify an event type
• properties: A container for the event properties as specified in the table below.

JavaScript Example (Web)

DY.API("event", {
  name: "Signup",
  properties: {
    dyType: "signup-v1",
    hashedEmail: "...", // SHA256 encoding of the lowercase e-mail, if the e-mail is known
   
  }
});

The user has changed the sorting of a product list.

Parameters

• name: Human-readable name, not used to identify an event type
• properties: A container for the event properties as specified in the table below.

JavaScript Example (Web)

DY.API("event", {
  name: "Sort Items",
  properties: {
    dyType: "sort-items-v1",
    sortBy: "PRICE",
    sortOrder: "ASC"
  }
});

Parameters

• name: Human-readable name, not used to identify an event type
• properties: A container for the event properties as specified in the table below.

JavaScript Example (Web)

DY.API("event", {
  name: "Sync cart",
  properties: {
    dyType: "sync-cart-v1",
    currency: "any supported currency code", // Optional non-default currency used
    cart: [ //Mandatory, the order of products should be from oldest to newest
      {
        productId: "sku-4324-bg",
        quantity: 2,
        itemPrice: 12.34,
      },
      {
        productId: "item-34454",
        quantity: 1,
        itemPrice: 34.45
      }
    ]
  }
});

The user has watched a video (in part or in full). You can distinguish between auto-playing videos and those that were explicitly clicked on by the user.

Parameters

• name: Human-readable name, not used to identify an event type
• properties: A container for the event properties as specified in the table below.

JavaScript Example (Web)

DY.API("event", {
  name: "Video Watch",
  properties: {
    dyType: "video-watch-v1",
    itemId: "...", // Mandatory string ID - must match an id present in the Content Feed
    categories: ["Sports", "Baseball"], // Optional, independent of whether an ID was given
    autoplay: true,
    progress: "VIDEO_PROGRESS",
    progressPercent: 65 // Meaning: 65% of video length has passed.
  }
});