Documentation Commerce Data Connection extension for Adobe Commerce

Create Custom Events

Last update: Mon Nov 13 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

Admin
Developer

You can extend the eventing platform by creating your own storefront events to collect data unique to your industry. When you create and configure a custom event, it is sent to the Adobe Commerce Events Collector.

Handle custom events

Custom events are supported for the Adobe Experience Platform only. Custom data is not forwarded to Adobe Commerce dashboards and metrics trackers.

For any custom event, the collector:

Adds identityMap with ECID as a primary identity
Includes email in identityMap as a secondary identity if personalEmail.address is set in the event
Wraps the full event inside an xdm object before forwarding to the Edge

Example:

Custom event published through Adobe Commerce Events SDK:

mse.publish.custom({
    commerce: {
        saveForLaters: {
            value: 1,
        },
    },
});

In Experience Platform Edge:

{
  xdm: {
    identityMap: {
      ECID: [
        {
          id: 'ecid1234',
          primary: true
        }
      ],
      email: [
        {
          id: "runs@safari.ke",
          primary: false
        }
      ]
    },
    commerce: {
        saveForLaters: {
            value: 1
        }
    }
  }
}

NOTE

Using custom events may affect default Adobe Analytics reports.

Handle event overrides (custom attributes)

Attribute overrides for standard events are supported for the Experience Platform only. Custom data is not forwarded to Commerce dashboards and metrics trackers.

For any event with customContext, the collector overrides joins fields set in the relevant contexts with fields in customContext. The use case for overrides is when a developer wants to reuse and extend contexts set by other parts of the page in already supported events.

NOTE

When overriding custom events, event forwarding to Experience Platform should be turned off for that event type to avoid double counting.

Examples:

Product view with overrides published though Adobe Commerce Events SDK:

mse.publish.productPageView({
    productListItems: [
        {
            productCategories: [
                {
                    categoryID: "cat_15",
                    categoryName: "summer pants",
                    categoryPath: "pants/mens/summer",
                },
            ],
        },
    ],
});

In Experience Platform Edge:

{
  xdm: {
    eventType: 'commerce.productViews',
    identityMap: {
      ECID: [
        {
          id: 'ecid1234',
          primary: true,
        }
      ]
    },
    commerce: {
      productViews: {
        value : 1,
      }
    },
    productListItems: [{
        SKU: "1234",
        name: "leora summer pants",
        productCategories: [{
            categoryID: "cat_15",
            categoryName: "summer pants",
            categoryPath: "pants/mens/summer",
        }],
    }],
  }
}

NOTE

Overriding events with custom attributes may affect default Adobe Analytics reports.

recommendation-more-help

6bf243c8-c8c6-4074-826f-546af445e840