Tracking consent events

Consent is a specific event type with a predefined structure. Every valid consent event must include 4 required attributes as defined below and the event name has to be "consent". Other attributes are defined either manually as custom attributes or generated automatically. You can specify and track any other custom attributes you need.

Consent events attributes

Attribute

Description

Required

Example

action

Options:
accept - Consent granted
reject - Consent revoked
Manual definition

Yes

"accept"

category

The ID of the consent category, as defined in project settings.
Manual definition

Yes

"newsletter"

timestamp

Date and time of the consent granted by your customer.
Manual definition

Yes

1528114618

valid_until

Multiple options:
unlimited
<timestamp> - Timestamp of the expiration date
Manual definition

Yes

"unlimited"

identification_type

Type of identification which was used while the customer was giving the consent. If the identification_type has value "application" that means, the consent was generated in application.
Automatically generated

No

"cookie" or "application"

identification

Identification value which was used while the customer was giving the consent.
Automatically generated

No

"dab8a3d0d868126"

source

Multiple options:
crm - Manually created consent in the application.
import - Consent imported from the import wizard.
public_api - Most likely tracking API, which uses only public token for authentication
private_api - API which uses basic authentication
page - Tracked from the consent page
scenario - Tracked from the scenario from event node
Automatically generated

No

"import"

imported_timestamp

Timestamp of the import or tracking the event into Exponea
Automatically generated

Yes - automatic

"1522071973"

email

Email of the person who provided the consent.

No

[email protected]

message

Full quotation of the consent message that the customer reacted to.

No

Do you agree to...?

📘

Discard/remove a valid consent

There are two options to discard existing consent in Exponea.

  1. Automatic - Every consent includes information valid_until. If a current date is after date included in valid_until, this consent is automatically discarded.
  2. Manual - Track a consent with information action = reject.

More information about consent events in particular are in consent event definition.

Tracking consents to Exponea

Tracking consents in Exponea is easy. Exponea provides 4 different ways to do that.

Batch imports

Exponea supports batch loading of consents. You can either connect Exponea to your existing database or provide consents in a CSV file format. If you decide to load consents via batch imports, you have to define 4 required consent attributes. Learn about required attributes here..

action,category,valid_until,timestamp,customer_id
reject,weekly_newsletter,unlimited,1522158555,[email protected]
accept,weekly_newsletter,unlimited,1522156555,[email protected]
accept,push_notification,1522112345,1522152855,[email protected]

CRM

You can manually grant or revoke consent for each customer in the customer view. Go to Data & Assets > Customers > click on the desired customer > click on Consents, where you are able to see and change the customer's status for each category.

API tracking

You can track consents real-time from your website or from your internal systems. More information about tracking can be found in the Javascript SDK article. Tracking of a new event is also explained here.

{
    "customer_ids": {
        "registered":"{{ customer_ids.registered }}" // choose which IDs to use for identification
    },
    "event_type": "consent",
    "properties": {
  action: "accept",
  category: "weekly_newsletters_from_web",
  timestamp: 1528114618,
  identification_type: "email",
  identification: "[email protected]",
  source: "public_api",
  valid_until: "unlimited",
  message: "This consent was tracked from landing page" // additional attribute
    }
}

Consent page

Your customers can manage their subscriptions on our consent page, which automatically tracks their changes and can be easily customized. Read more here.

Invalid consents

If a consent event doesn´t meet requirements described in the table above, it is considered as invalid. Invalid consents are visible in the customer consent overview being marked as invalid. Invalid consent event is not taken into account.

Updated about a year ago


Tracking consent events


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.


We rely on cookies

to optimize our communication and to enhance your customer experience. By clicking on the Accept and Close button, you agree to the collection of cookies. You can also adjust your preferences by clicking on Manage Preferences. For more information please see our Privacy policy.

Manage cookies
Accept & close

Cookies preferences

Accept & close
Back