[Alpha]{class="badge informative"}

sendEvent (Server SDK)

This page describes the Server SDK sendEvent method. For the Web SDK, see sendEvent.

The sendEvent method is the primary way to send data to Adobe from your server. Its result is also how you retrieve personalized content. Use the xdm object to send data that maps to your Adobe Experience Platform schema, and the data object to send other data.

Call sendEvent on the forRequest handle for the current visitor, after configure resolves:

const visitor = alloy.forRequest({ request: req });

const result = await visitor.sendEvent({
  type: "commerce.purchases",
  xdm: {
    identityMap: {
      Email: [{ id: "visitor@example.com", primary: true }]
    },
    commerce: {
      purchases: { value: 1 },
      order: {
        purchaseID: "a8g784hjq1mnp3",
        currencyCode: "USD",
        priceTotal: 999.98
      }
    }
  },
  data: {
    loyaltyTier: "gold"
  },
  personalization: {
    decisionScopes: ["order-confirmation-offer"]
  },
  edgeConfigOverrides: {
    com_adobe_analytics: {
      reportSuites: ["examplersid1"]
    }
  }
});

The SDK sends each event to the authenticated Edge Network Server API at server.adobedc.net. See Authentication.

Requirements requirements

Options options

If you pass an option that the SDK doesn’t recognize, sendEvent rejects with an Unknown field error.

Options that have no effect on a server no-effect

The Server SDK accepts the following Web SDK options so that you can share event-building code with a browser implementation. However, they depend on a browser and have no effect on the server:

Don’t set documentUnloading on a server. It doesn’t apply outside a browser. For visitors who already have an identity, it makes the SDK send the event as an unauthenticated request to the edgeDomain instead of to the authenticated Server API. That endpoint doesn’t return a response, so sendEvent doesn’t return propositions.

The deprecated datasetId and mergeId options are still accepted. Instead of datasetId, use com_adobe_experience_platform.datasets.event.datasetId in edgeConfigOverrides.

Result object result

The sendEvent method returns a promise. See Handle results. When the promise resolves, the result object can contain the following property:

If you don’t request personalization, or the event isn’t sent because of consent or onBeforeEventSend, the result is an empty object.

const { propositions = [] } = await visitor.sendEvent({
  xdm: {
    eventType: "decisioning.propositionFetch",
    identityMap: {
      Email: [{ id: "visitor@example.com", primary: true }]
    }
  },
  personalization: {
    surfaces: ["web://example.com/home"]
  }
});

Unlike the Web SDK, the result never contains inferences or destinations.