Adobe CJM ExperienceEvent - Message interaction details Schema

https://ns.adobe.com/experience/customerJourneyManagement/message-interaction

Describes interaction made by the profile on the message.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Stable	No	Forbidden	Permitted	adobe/experience/customerJourneyManagement/message-interaction.schema.json

Schema Hierarchy

Adobe CJM ExperienceEvent - Message interaction details https://ns.adobe.com/experience/customerJourneyManagement/message-interaction
- Extensibility base schema https://ns.adobe.com/xdm/common/extensible
- Adobe ExperienceEvent - Offer details https://ns.adobe.com/experience/customerJourneyManagement/offers

Adobe CJM ExperienceEvent - Message interaction details Examples

{
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "click",
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/urlID": "123",
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/messageInteraction/trackingType": "offer",
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/tags": [
    "marketing",
    "apparel"
  ],
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label": "adobe.com",
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/offers": {
    "xdm:offerID": "1234",
    "xdm:placementID": "12345",
    "xdm:propositionID": "9898",
    "xdm:offerCount": 5,
    "xdm:scopeID": "eyJ4ZG06YWN0aXZpdHlJZCI6IjQ1NjciLCJ4ZG06cGxhY2VtZW50SWQiOiIxMjM0NSJ9",
    "xdm:activityID": "4567"
  }
}

{
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "subscription",
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/tags": [
    "marketing",
    "apparel"
  ],
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label": "adobe.com",
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription": {
    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/subscriptionListID": "daily-news",
    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/source": "landingPageId",
    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/sourceType": "internal",
    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/subscriptionChoice": "yes"
  }
}

{
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "submit",
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/urlID": "123",
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/messageInteraction/trackingType": "tracked",
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/messageInteraction/entityType": "landing_page",
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label": "adobe.com",
  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingpage": {
    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingpageID": "1234",
    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/source": "journey",
    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/sourceType": "internal",
    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingPageName": "December Offers",
    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/formData": {
      "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscriptions": {
        "Winter_Carnival_Offers": {
          "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/val": "y",
          "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/type": "email"
        },
        "Black_Friday_Offers": {
          "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/val": "n",
          "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/type": "email"
        }
      },
      "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/consents": {
        "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/channel": {
          "email": {
            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/val": "y"
          }
        },
        "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/idSpecific": {
          "johndoe@adobe.com": {
            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/val": "y"
          }
        }
      },
      "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscriberContactAddress": "johndoe@adobe.com"
    },
    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/additionalData": {
      "Campaign_Id": "Nike@1234"
    }
  }
}

Adobe CJM ExperienceEvent - Message interaction details Properties

Property	Type	Required	Defined by
https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/entityType	`enum`	Optional	Adobe CJM ExperienceEvent - Message interaction details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType	`enum`	Optional	Adobe CJM ExperienceEvent - Message interaction details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label	`string`	Optional	Adobe CJM ExperienceEvent - Message interaction details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingpage	`object`	Optional	Adobe CJM ExperienceEvent - Message interaction details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/offers	Adobe ExperienceEvent - Offer details	Optional	Adobe CJM ExperienceEvent - Message interaction details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription	`object`	Optional	Adobe CJM ExperienceEvent - Message interaction details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/tags	`string[]`	Optional	Adobe CJM ExperienceEvent - Message interaction details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/trackingType	`string`	Optional	Adobe CJM ExperienceEvent - Message interaction details (this schema)
https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/urlID	`string`	Optional	Adobe CJM ExperienceEvent - Message interaction details (this schema)
`*`	any	Additional	this schema allows additional properties

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/entityType

The entity in whose context this event is published

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/entityType

is optional
type: enum
defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/entityType Known Values

Value	Description
`landing_page`	Event is related to landing page entity
`message`	Event is related to message entity

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType

Interaction Type

Specify action made by user on a message.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType

is optional
type: enum
defined in this schema

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType Known Values

Value	Description
`click`	Message link clicked.
`open`	Message opened.
`unsubscribe`	Unsubscribed from messages.
`spam_complaint`	Message is marked as spam by the user.
`subscription`	Subscribe / Unsubscribe to a subscription list.
`submit`	Submit message.
`visit`	Message visited.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label

Tracker URL Label

Human-Friendly label.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label

is optional
type: string
defined in this schema

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label Type

string

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingpage

Landing Page Details

Describes landing pages involved in a message interaction.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingpage

is optional
type: object
defined in this schema

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingpage Type

object with following properties:

Property	Type	Required
`https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/additionalData`	object	Optional
`https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/formData`	object	Optional
`https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingPageID`	string	Optional
`https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingPageName`	string	Optional
`https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/source`	string	Optional
`https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/sourceType`	string	Optional

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/additionalData

Additional Data

Additional data added by the marketer while authoring the landing page.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/additionalData

is optional
type: object

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/additionalData Type

Unknown type object.

{
  "title": "Additional Data",
  "type": "object",
  "description": "Additional data added by the marketer while authoring the landing page.",
  "meta:xdmType": "map",
  "additionalProperties": {
    "type": "string",
    "description": "Values of additional data added by the marketer while authoring the landing page. "
  },
  "simpletype": "`object`"
}

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/formData

Form Data

Data filled by the user on the landing page form.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/formData

is optional
type: object

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/formData Type

Unknown type object.

{
  "title": "Form Data",
  "type": "object",
  "description": "Data filled by the user on the landing page form.",
  "properties": {
    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscriptions": {
      "title": "Subscription details.",
      "type": "object",
      "description": "Subscription details input by the end user in the landing page.",
      "meta:xdmType": "map",
      "additionalProperties": {
        "type": "object",
        "description": "Subscription details input by the end user in the landing page. ",
        "properties": {
          "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/val": {
            "title": "Subscription Choice",
            "type": "string",
            "description": "Subscription Choice for the Subscription List.",
            "enum": [
              "y",
              "n",
              "p",
              "u"
            ],
            "meta:enum": {
              "y": "Subscribed to Subscription List",
              "n": "Unsubscribed to Subscription List",
              "p": "Subscription Pending",
              "u": "Subscription Unknown"
            }
          },
          "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/type": {
            "title": "Subscription Type",
            "type": "string",
            "description": "The type of subscription."
          }
        }
      }
    },
    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/consents": {
      "title": "Consent details.",
      "type": "object",
      "description": "Consent details input by the end user in the landing page.",
      "properties": {
        "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/channel": {
          "title": "Channel level consent details",
          "type": "object",
          "description": "Consent details specific to channel like email/push etc",
          "meta:xdmType": "map",
          "additionalProperties": {
            "type": "object",
            "description": "Consent details specific to channel like email/push etc",
            "properties": {
              "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/val": {
                "title": "Consent choice",
                "type": "string",
                "description": "Consent choice for the channel.",
                "enum": [
                  "y",
                  "n",
                  "p",
                  "u"
                ],
                "meta:enum": {
                  "y": "Subscribed to channel",
                  "n": "Unsubscribed to channel",
                  "p": "Subscription Pending",
                  "u": "Subscription Unknown"
                }
              }
            }
          }
        },
        "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/idSpecific": {
          "title": "Contact address level consent details.",
          "type": "object",
          "description": "Consent details specific to contact address.",
          "meta:xdmType": "map",
          "additionalProperties": {
            "type": "object",
            "description": "Consent details specific to contact address.",
            "properties": {
              "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/val": {
                "title": "Consent choice",
                "type": "string",
                "description": "Consent choice for the contact address.",
                "enum": [
                  "y",
                  "n",
                  "p",
                  "u"
                ],
                "meta:enum": {
                  "y": "Contact address subscribed",
                  "n": "Contact address unsubscribed",
                  "p": "Subscription Pending",
                  "u": "Subscription Unknown"
                }
              }
            }
          }
        }
      }
    },
    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscriberContactAddress": {
      "title": "Contact address specified by the subscriber.",
      "type": "string",
      "description": "Contact address specified by the subscriber."
    }
  },
  "simpletype": "`object`"
}

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingPageID

Landing Page ID

Unique Identifier for Landing Page.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingPageID

is optional
type: string

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingPageID Type

string

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingPageName

Landing Page Name

Human-Friendly name of landing page.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingPageName

is optional
type: string

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingPageName Type

string

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/source

Source

Source of the Landing page.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/source

is optional
type: string

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/source Type

string

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/sourceType

Source Type

Type of the Source of Landing Page.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/sourceType

is optional
type: enum

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/sourceType Known Values

Value	Description
`internal`	Internal for AJO Landing Page
`external`	External for Non-AJO Landing Page

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/offers

Offer Details

Describes offer(s) involved in a message interaction.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/offers

is optional
type: Adobe ExperienceEvent - Offer details
defined in this schema

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/offers Type

Adobe ExperienceEvent - Offer details – https://ns.adobe.com/experience/customerJourneyManagement/offers

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription

Subscription Details

Describes subscription involved in a message interaction.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription

is optional
type: object
defined in this schema

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription Type

object with following properties:

Property	Type	Required
`https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/source`	string	Optional
`https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/sourceType`	string	Optional
`https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscriptionChoice`	string	Optional
`https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscriptionListID`	string	Optional

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/source

Source

Source of the Subscription List.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/source

is optional
type: string

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/source Type

string

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/sourceType

Source Type

Type of the Source of Subscription List.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/sourceType

is optional
type: enum

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/sourceType Known Values

Value	Description
`internal`	Internal for AJO Landing Page
`external`	External for Non-AJO Landing Page

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscriptionChoice

Subscription Choice

Subscription Choice for the Subscription List.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscriptionChoice

is optional
type: enum

The value of this property must be equal to one of the known values below.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscriptionChoice Known Values

Value	Description
`yes`	Subscribed to Subscription List
`no`	Unsubscribed to Subscription List
`pending`	Subscription Pending
`unknown`	Subscription Unknown

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscriptionListID

Subscription List ID

Unique Identifier for Subscription List.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscriptionListID

is optional
type: string

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscriptionListID Type

string

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/tags

Link Tags

The tags present on this link.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/tags

is optional
type: string[]
defined in this schema

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/tags Type

Array type: string[]

All items must be of the type: string

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/trackingType

URL Tracking Type

The tracking type of the URL. It may be subscription, or a user-defined category.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/trackingType

is optional
type: string
defined in this schema

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/trackingType Type

string

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/trackingType Known Values

Value	Description

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/urlID

Tracker URL ID

Unique Identifier of the URL clicked by the user.

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/urlID

is optional
type: string
defined in this schema

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/urlID Type

string

FilesExpand file tree

message-interaction.schema.md

Latest commit

History

message-interaction.schema.md

File metadata and controls

Adobe CJM ExperienceEvent - Message interaction details Schema

Schema Hierarchy

Adobe CJM ExperienceEvent - Message interaction details Examples

Adobe CJM ExperienceEvent - Message interaction details Properties

The entity in whose context this event is published

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/entityType Known Values

Interaction Type

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType Known Values

Tracker URL Label

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label Type

Landing Page Details

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingpage Type

Additional Data

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/additionalData Type

Form Data

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/formData Type

Landing Page ID

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingPageID Type

Landing Page Name

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/landingPageName Type

Source

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/source Type

Source Type

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/sourceType Known Values

Offer Details

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/offers Type

Subscription Details

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription Type

Source

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/source Type

Source Type

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/sourceType Known Values

Subscription Choice

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscriptionChoice Known Values

Subscription List ID

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscriptionListID Type

Link Tags

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/tags Type

URL Tracking Type

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/trackingType Type

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/trackingType Known Values

Tracker URL ID

https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/urlID Type