Skip to content

doc: New support for per-rcpt tracking (SparkPost/Momentum#1391) #859

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dkoerichbird merged 1 commit into from
Jul 14, 2026
+30 −6
Merged

doc: New support for per-rcpt tracking (SparkPost/Momentum#1391) #859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 26 additions & 4 deletions content/momentum/4/engagement-tracking-http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
lastUpdated: "03/26/2020"
lastUpdated: "07/13/2026"
title: "Tracking Engagement for HTTP"
description: "Introduction Understanding how your messaging is or isn't performing is a critical factor in creating a successful campaign Just knowing that your messages are being delivered is not enough You need to know how your customers interact with your message content Are your customers opening your messages Are they clicking..."
---
Expand All @@ -8,7 +8,7 @@ description: "Introduction Understanding how your messaging is or isn't performi

Understanding how your messaging is or isn't performing is a critical factor in creating a successful campaign. Just knowing that your messages are being delivered is not enough. You need to know how your customers interact with your message content. Are your customers opening your messages? Are they clicking the links you provide? Momentum provides real-time event tracking data, enabling you to track campaigns as they are being sent and to make modifications to improve customer engagement.

Engagement describes how a recipient interacts with your message. An engagement event occurs when the recipient opens an email or clicks a link within an email. By default, open tracking and click tracking are enabled in Momentum's configuration, if Message Generation is selected during installation. You can override the configuration option for a specific stored template by specifying the attributes in the template or for a specific transmission by specifying the attributes in the transmission. For details about these attributes, see the Transmissions and Templates API documentation available at [Momentum 4 REST API](https://support.messagesystems.com/docs/web-rest/v1_index.html).
Engagement describes how a recipient interacts with your message. An engagement event occurs when the recipient opens an email or clicks a link within an email. By default, open tracking and click tracking are enabled in Momentum's configuration, if Message Generation is selected during installation. You can override the configuration option for a specific stored template by specifying the attributes in the template, for a specific transmission by specifying the attributes in the transmission, or for an individual inline recipient by specifying the attributes in that recipient's `options` object. For details about these attributes, see the Transmissions and Templates API documentation available at [Momentum 4 REST API](https://support.messagesystems.com/docs/web-rest/v1_index.html).

### Note

Expand Down Expand Up @@ -85,16 +85,38 @@ Follow these steps to create a transmission with a link in the message body:

The precedence for engagement tracking options, from highest to lowest is as follows:

* recipient level

* transmission level

* template level

* msg_gen level

For example, if click tracking is not specified at the transmission level, the "click_tracking" attribute at the template level is used. If the template level is also not specified, the setting of the configuration option in the msg_gen module is used.
For example, if click tracking is not specified at the recipient level, the "click_tracking" attribute at the transmission level is used. If the transmission level is also not specified, the "click_tracking" attribute at the template level is used, and if that is not specified either, the setting of the configuration option in the msg_gen module is used.

By default, open tracking and click tracking are enabled in Momentum's configuration, if Message Generation is selected during installation.

**Per-recipient overrides.** For **inline** recipients, you can set `open_tracking`, `click_tracking`, and `initial_open` in an `options` object on an individual recipient. When present, a recipient's flag overrides the transmission-level flag for that recipient only; when a flag is omitted, that recipient inherits the transmission-level behavior. This lets you mix tracked and untracked recipients in a single transmission — for example, disabling tracking for transactional recipients while leaving it enabled for everyone else. Per-recipient overrides apply to inline recipients on the REST Transmissions API only (not stored recipient lists or the SMTP `X-MSYS-API` path).

In the following example, recipient A disables open and click tracking for itself, while recipient B inherits the transmission-level settings (both enabled):

```
"options":{
"open_tracking":true,
"click_tracking":true
},
"recipients":[
{
"address":{ "email":"a@example.com" },
"options":{ "open_tracking":false, "click_tracking":false }
},
{
"address":{ "email":"b@example.com" }
}
]
```

2. Inject your message into Momentum.

At the command line, enter the following command to inject your email:
Expand Down Expand Up @@ -133,4 +155,4 @@ Follow these steps to view your engagement data:

![Engagement Report](images/engagement.png)

Congratulations! You have successfully sent an email with a link and tracked the engagement of your message in the UI. To learn more about using the Engagement report, see [“Evaluating Your Campaign Performance”](/momentum/4/web-ui-reports-evaluating-campaign-performance).
Congratulations! You have successfully sent an email with a link and tracked the engagement of your message in the UI. To learn more about using the Engagement report, see [“Evaluating Your Campaign Performance”](/momentum/4/web-ui-reports-evaluating-campaign-performance).
6 changes: 4 additions & 2 deletions content/momentum/4/modules/msg-gen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
lastUpdated: "10/05/2021"
lastUpdated: "07/13/2026"
title: "msg_gen – Message Generation"
description: "The msg gen module handles message generation which is triggered by injecting messages using HTTP The module accepts the components of a transmission including recipient list template and message content and constructs a personalized message for each recipient The generated message is then queued for delivery Each transmission is handled..."
---
Expand Down Expand Up @@ -174,10 +174,12 @@ To enable this functionality the `scheduled_send` and [`keep_message_dicts_in_me

The precedence for engagement tracking options, from highest to lowest is as follows:

* recipient level (inline recipients only)

* transmission level

* template level

* msg_gen level

For example, if click_tracking is not specified at the transmission level, the value at the template level is used. If the template level is also not specified, the setting of the configuration option in the msg_gen module is used.
For example, if click_tracking is not specified at the recipient level, the value at the transmission level is used. If the transmission level is also not specified, the value at the template level is used, and if that is not specified either, the setting of the configuration option in the msg_gen module is used. A recipient-level flag (`open_tracking`, `click_tracking`, or `initial_open` in an inline recipient's `options` object) overrides the transmission-level flag for that recipient only; see [“Tracking Engagement for HTTP”](/momentum/4/engagement-tracking-http).
Loading