Outbound events relate to outbound communications to your customers, such as emails and push notifications. These events store information about the messages, as well as customer interactions with these messages, such as opening an email.
Note that ActivatePro automatically collects events for messages sent out via ActivatePro Integrations. However, if you are using other outbound communication services, you should upload these events to the ActivatePro system. Please go to Data Management to learn more.
Events
- Message Sent
- Message Delivered
- Message Viewed
- Message Clicked
- Message Unsubscribed
- Message soft_bounced
- Message hard_bounced
- Message marked_as_spam
Different Third Party Providers might only support a subset of these events. For example, the Episerver (Optimizely) Integration provides Message Sent event, but does not provide Message Delivered Events.
Properties
| Properties | Description | Mandatory | Example |
|---|---|---|---|
| userId | Unique identifier for each customer | yes | ABC12345 |
| timestamp | The date and time of the event | yes* | 2022-01-11T00:00:00Z |
| channel | Channel used to send the message | ||
| type | categorization of the message | Newsletter | |
| url | URL | ||
| campaignId | Campaign Identified | 123456 | |
| messageId | Message identifier | 304405 |
*If no timestamp is provided, the system will use the time of ingestion as timestamp.
Examples
You can upload these events using the ActivatePro API, or via the Event Feed. Please go to Data Management to learn more.
Here is an example of the JSON used to upload an event via the API.
{
"id": "ABC12345",
"events": [{
"event": "Message Sent",
"timestamp": "2022-01-11T00:00:00Z"
"properties": {
"channel": "Email",
"type": "Newsletter"
}},
{
"event": "Message Delivered",
"timestamp": "2022-01-11T00:00:00Z"
"properties": {
"channel": "Email",
"type": "Newsletter"
}}]}
Here is the same example, presented as a JSON file that can be uploaded via Data Feeds:
[
{
"id": "ABC12345",
"event": "Message Sent",
"timestamp": "2022-01-11T00:00:00Z",
"channel": "Email",
"type": "Newsletter"
},
{
"id": "ABC12345",
"event": "Message Delivered",
"timestamp": "2022-01-11T00:00:00Z",
"channel": "Email",
"type": "Newsletter"
}
]