Import Events

It is possible to import any other event other than orders in the Event Feed. In order to do this, the events need to have the same .JSON structure as the events that have been set up in the Web Tracking. For more information regarding pre-defined events in CrossEngage, see here.

Note the following requirements:

  • Zip can only contain one file.

  • The name of the archived file must be the same as the name of the archive. (e.g., event_history_20191118170500.json โ†’ event_history_20191118170500.json.zip)

  • The requirements are not enforced on upload; if not observed, the file will be imported successfully, but marked as failed, and the zip file will not be moved.

Naming Convention

The naming convention for the event feed file is the following:

โ€œevent_history_โ€+YYYYMMDDHHMMSS.json (UTC)

Data File

The format of the file is very similar to the order feed structure described above. On top of the listed attributes, you will need to add the following key to each entry:

Key

Description

Data Type

Required

Example

event

Name of the Event youโ€™re sending

string

yes

Subscribed Newsletter

Order Feed is uploaded in the root of SFTP account. The CrossEngage importer will then add each event according to the specified name. Please ensure that the data you are providing in the Event Feed is consistent with the data you are sending with the Web Tracking.

The only technical mandatory fields are the event and the id. The id refers to the user identifier you have assigned to a customer in your data warehouse and is named externalId in other places in the platform incl. the UI. This is the same id you might be already sending through our Tracking SDK or User Management API.

The combination of email and businessUnit of a user or lead is also a unique identifier and can be used instead or additionally to the external Id when importing events.

Please note that if there can be leads (users without an external Id) in the platform and you are also using the user feed import to upgrade these leads to full users (by adding the external Id to a profile with the matching email and businessUnit) then the user feed import needs to run first before any event- or orderfeed, or the system can't match the ids and creates new users instead.

This will not be necessary, if you include the email and businessUnit in the events.

Event Feed Example:

[
  {
    "event": "Changed Order Status",
    "orderId": "0006000384",
    "timestamp": "2018-05-22T22:00:00Z",
    "businessUnit": "DE",
    "orderType": "Click & Reserve Order",
    "numberOfUniqueItems": 1,
    "numberOfItems": 2,
    "total": 7.98,
    "discount": 0,
    "shipping": 0,
    "id": "e6bce5b3816eedd2cdd397256d6cee29d5b142ae821470c3b6883ee4b15f9499",
    "email":"example@example.com",
    "businessUnit":"crossengage"
    "cart": {
      "currency": "EUR",
      "total": 7.98,
      "products": [
        {
          "sku": "AMA0159270DE",
          "currency": "EUR",
          "quantity": 2,
          "price": 3.99,
          "name": "Ribbon Lace, B:2,5cm x L:3m, white",
          "category": "Decorative Bands",
          "id": "AMA0159270DE"
        }
      ]
    }
  }
]

Last updated