Campaign and channel events
This topic describes delivery events, engagement events, attributable events, disengagement events, and reachability events in Optimizely Data Platform (ODP).
All Delivery, Engagement, Attributable, Disengagement, and Reachability events which a channel app sends into ODP must be specified in the app.yml.
Delivery Events
Delivery events record events along the delivery pipeline. Minimally, these consist of sent events.
The Event Type (type) for these events is the channel.type specified in app.yml.
Event Action action | Description |
|---|---|
| sent | records that a send occurred; this is an Optimizely-generated event |
| delivery | records a successful delivery of a message occurred |
| delivery_unknown | records that it was unknown whether a message delivery was successful or unsuccessful; typically only used when delivery events are also possible |
Engagement Events
Engagement events record when a message recipient has a positive interaction with the message.
The Event Type (type) for these events is the channel.type specified in app.yml.
Event Action action | Description |
|---|---|
| open | records that a recipient opened a message |
| click | records that a recipient clicked a message |
| engage | records that a recipient generically engaged with a message; used when the engagement action does not cleanly fit into another action option |
Attributable Events
These are not _additional _events sent into ODP but rather an indication that otherwise-specified events should be used for the purposes of attribution modeling.
Attributable actions are used in Optimizely's attribution model to determine which campaigns get credit for a conversion. These often, but not always, mirror Engagement actions.
Event Action action | Description |
|---|---|
| open | indicates that conversions can be attributed to open events |
| click | indicates that conversions can be attributed to click events |
| engage | indicates that conversions can be attributed to engage events |
| delivery | indicates that conversions can be attributed to delivery events |
Disengagement Events
Disengagement events are recorded when a message recipient has a negative interaction with the message.
Event Type type | Event Action action | Reachability Update Type reachability_update_type | List Id list_id |
|---|---|---|---|
| content | opt-out | ||
| reachability | unreachable | spam_report | |
| list | unsubscribe | [list_id] | |
| [channel.type] | disengage |
Reachability Events
Reachability events are recorded when a message could not be delivered.
Event Type type | Event Action action | Reachability Update Type reachability_update_type | Description |
|---|---|---|---|
| reachability | unreachable | hard_bounce | records that a message could not be delivered for a permanent reason (for example, email address does not exist) |
| [channel.type] | soft_bounce | records that a message could not be delivered for an impermanent reason (for example, mailbox is full) |
Must be a messaging identifier
You can only retrieve reachability events for messaging identifiers. For more information about identifiers in ODP, see our developer documentation.
Updated 6 months ago