The activity data model defines every field associated with an activity. When an activity is imported or created in(to) Connect, the connector populates these fields. When an activity is exported from Connect, each field is mapped to its counterpart in the external platform.
The data model gives insight into the data saved with each activity and what data is available for rule building.
In this article you will learn more about:
Data model
The activity data model is slightly more complicated than other data models. In one of the fields in the basic data model, specific fields are included for different types of activities. Therefore, it's impractical to provide a single overview. Instead, the data model displays a base template that is similar for all activities, along with the specific fields available for each activity type.
Common data model for activities
| Fields |
Description |
Example of input |
Required |
| Id |
Activity ID |
"8720053089907" |
Yes |
| Kind |
Activity type – the content of this field differs per activity |
String based |
Yes |
| Sourcename |
Name of activity in source |
"Test event" |
|
| Reference |
Reference of activity |
"938731" |
Yes |
| ContactId |
ID of contact related to activity |
"d7c65267-4dac-4b4b-93b4-cfa5e014e640" |
|
| ContactReference |
Reference of contact related to activity |
"123d38" |
|
| ContactEmail |
Email address of contact related to activity |
"placeholder@email.com" |
|
| ContactPhone |
Phone number of contact related to activity |
"0031612345678" |
|
| Timestamp |
Timestamp of activity |
"2025-07-09T12:34:56Z" |
Yes |
Specific data models
Type: Email was sent
| Fields |
Description |
Example of input |
Required |
| Campaign |
Campaign name |
"Feature launch" |
|
| OnlineVersionUrl |
Online version URL |
"https://mail.com/feature/29129..." |
|
| Subject |
Subject |
"New feature has launched" |
|
| Kind |
Subtype of activity |
"ActivityTriggerKind::Mailing" |
|
| TriggerReference |
Reference of activity |
"d7c65267-4dac-4b4b-93b4-cfa5e014e640" |
|
Type: Email was opened
| Fields |
Description |
Example of input |
Required |
| Campaign |
Campaign name |
"Feature launch" |
|
| OnlineVersionUrl |
Online version URL |
"https://mail.com/feature/29129..." |
|
| Subject |
Subject |
"New feature has launched" |
|
| Kind |
Subtype of activity |
"ActivityTriggerKind::Mailing" |
|
| TriggerReference |
Reference of activity |
"d7c65267-4dac-4b4b-93b4-cfa5e014e640" |
|
Type: Email was bounced
| Fields |
Description |
Example of input |
Required |
| Campaign |
Campaign name |
"Feature launch" |
|
| OnlineVersionUrl |
Online version URL |
"https://mail.com/feature/29129..." |
|
| Subject |
Subject |
"New feature has launched" |
|
| Kind |
Subtype of activity |
"ActivityTriggerKind::Mailing" |
|
| BounceType |
Bounce type, either hard or soft |
"BounceType::Soft" |
Yes |
| TriggerReference |
Reference of activity |
"d7c65267-4dac-4b4b-93b4-cfa5e014e640" |
|
Type: Subscribe
| Fields |
Description |
Example of input |
Required |
| Channel |
Channel |
"SMS" |
|
| Preference |
Preference |
"Newsletter" |
|
| Campaign |
Campaign name |
"Test event" |
|
| TriggerReference |
Reference of activity |
"d7c65267-4dac-4b4b-93b4-cfa5e014e640" |
|
Type: Unsubscribe
| Fields |
Description |
Example of input |
Required |
| Channel |
Channel |
"SMS" |
|
| Preference |
Preference |
"Newsletter" |
|
| Campaign |
Campaign name |
"Test event" |
|
| TriggerReference |
Reference of activity |
"d7c65267-4dac-4b4b-93b4-cfa5e014e640" |
|
Type: Email link was clicked
| Fields |
Description |
Example of input |
Required |
| Campaign |
Campaign |
"Feature launch" |
|
| OnlineVersionUrl |
Online version URL |
"https://mail.com/feature/29129..." |
|
| Subject |
Subject |
"New feature has launched" |
|
| Kind |
Subtype of activity |
"ActivityTriggerKind::Mailing" |
|
| Link |
Clicked link |
"https://mail.com/feature/29129..." |
|
| LinkName |
Anchor of clicked link |
"Find out more" |
|
| UtmId |
UTM ID |
"9383747" |
|
| UtmSource |
UTM source |
"Active users" |
|
| UtmMedium |
UTM medium |
"email" |
|
| UtmCampaign |
UTM campaign |
"featurelaunch" |
|
| UtmTerm |
UTM term |
"email+marketing" |
|
| UtmContent |
UTM content |
"top-cta-button" |
|
| TriggerReference |
Reference of activity |
"d7c65267-4dac-4b4b-93b4-cfa5e014e640" |
|
Type: SMS was sent
| Fields |
Description |
Example of input |
Required |
| Campaign |
Campaign |
"Feature launch" |
|
| TriggerReference |
Subtype of activity |
"ActivityTriggerKind::Mailing" |
|
Type: Purchase
| Fields |
Description |
Example of input |
Required |
| PurchaseProperties |
Comma separated properties |
""TotalValue": 500, "Currency": "EUR" |
Yes |
| Link |
Clicked link |
"https://mail.com/feature/29129..." |
|
| LinkName |
Anchor of clicked link |
"Find out more" |
|
| UserAgent |
User agent |
"Mozilla/5.0 (Macintosh;...)" |
|
| UtmCampaign |
UTM campaign |
"Feature launch" |
|
| UtmContent |
UTM content |
"top-cta-button" |
|
| UtmMedium |
UTM medium |
"email" |
|
| UtmSource |
UTM Source |
"active users" |
|
| UTMTerm |
UTM term |
"Email+marketing" |
|
| Browser |
Browser |
"null" |
|
| Device |
Device |
"browser" |
|
| Referrer |
Referrer |
"null" |
|
API documentation
If you are looking into using this data model for your own connector, please visit the API documentation for Spotler Connect.