This is a html view of the json schema please take the json schema as reference DOWNLOAD THE JSON SCHEMA

User Request

Type: object

This object describe a user/customer behaviour. For example, the marketing team would like to trigger a journey whenever a Cart is deemed to have been abandoned.

root eventHeader
Type: object

This object is used to describe some technical meta information related to the event

root eventHeader source
Type: enum (of string)

The application source of this event

Must be one of:

  • "OPCO"

root eventHeader version
Type: enum (of string)

The version of the json format event

Must be one of:

  • "v1"

root behaviourType
Type: enum (of string)

The user behaviour type

Must be one of:

  • "ABANDONED_CART"

Example:

"ABANDONED_CART"

root contact
Type: object

root contact email
Type: string

User's email.
Example:

"geert@electracontractors.be"

root contact title
Type: string

User's title.
Example:

"Dhr."

root contact firstName
Type: string

User's firstname.
Example:

"Geert"

root contact lastName
Type: string

User's lastname.
Example:

"Corijn"

root account
Type: object

root account opCoAccountId
Type: string

OpCo's organizatinal customer number that uniquely identifies its account. In the case of OpCo organised with a regional model or commercial organisation this should be suffix by '{orgId}'. if the accountId is 13563 and the orgId is OVIA so this field should contains 13563OVIA
Examples:

"1234567"

"1234567_OVIA"

root account commercialNumber
Type: string

VAT number or Siret number.
Example:

"GM4837192941"

root account accountName
Type: string

Name of the organizational customer.
Example:

"Independent Electric"

root account orgId
Type: string

Optional field, needed by OpCo organised with a regional model or commercial organisation. It can be used to filter or route based on the orgId.
Examples:

"org123"

"SNE"

root additionalInformations
Type: array

Additional information

 No Additional Items

Each item of this array must be:

root additionalInformations AdditionalInformation

AdditionalInformation

Type: object

Object representing an additional information of the behaviour

root additionalInformations AdditionalInformation name
Type: string

Name of the additional information
Examples:

"message"

"companyName"

root additionalInformations AdditionalInformation value
Type: string

Value of the additional information
Example:

"Super Elec"