Consent Schema

Consent Management is used to either grant or revoke consent in the Engagement Mobile SDK. When a customer opts in to tracking, the mobile application sends a consentLog event indicating the choice along with other events that got collected. When a customer opts out, a consentLog event is sent containing their choice and no other events are sent to Data Cloud.

Source Event PropertyTarget Schema Developer NameField TypeDescriptionCIM Object / Attribute
<Automatically Assigned>eventIdtextRequired. Typically the primary key for the engagement events.Privacy Consent Log /Privacy Consent Log Id
<Automatically Assigned>dateTimedatetimeRequired. Used for data partitioning for engagement events. ISO8601 supported format.Privacy Consent Log /Privacy Consent Activity Date Time
<Automatically Assigned>eventType = "consentLog"textRequired. The developerName of an event defined in the Web Connector schema.-
<Automatically Assigned>sessionIdtextRequired. The identifier of the session.-
<Automatically Assigned>deviceIdtextRequired. Typically the primary key for profile events.-
<Automatically Assigned>category = "Engagement"textRequired. Possible values are:
  • Engagement
  • Profile
Privacy Consent Log /Privacy Consent Log Category
consent.statusstatustextRequired. Possible values are:
  • Opt In
  • Opt Out
Privacy Consent Log /Privacy Consent Status
consent.providerprovidertextA named identifier indicating the consent management system providing the consent to the SDK-
consent.purposepurposetextWhat the user is consenting to. For example: TrackingPrivacy Consent Log /Consent Action