Skip to main content
The Add to Digest node adds the current event to a digest owned by a subscription topic. The digest accumulates events per user and releases them on the schedule configured for that topic, so you can send periodic summaries (a daily activity email, a weekly report) instead of one notification per event. Use Add to Digest when releases should follow a fixed schedule that the user controls. Use the Batch node instead when you want to release based on volume or an inactivity window within the journey itself.
Unlike Automations (which need two separate automations, one to collect and one to release), a journey needs only the Add to Digest node. Collection happens at the node; release is handled by the subscription topic’s schedule and mapped template, not by a second journey. The digest is sent through the topic’s template, so you do not add a Send node after Add to Digest to deliver it.

Configuration

FieldDescription
Subscription topicRequired. The subscription topic that owns the digest the event is added to. Events accumulate per user, identified by user_id (or userId) in the event data.
ConditionsOptional. Only add the event to the digest when the conditions evaluate true.

Configure the Digest on the Topic

The schedule, categories, retention, and template mapping live on the subscription topic, not on the node. Configure them in the Preferences Editor:
  • Schedule: when the digest releases (at least one schedule is required; multiple appear as choices on the hosted preferences page).
  • Categories: separate types of data within one digest, each with its own retention (First, Last, Highest, or Lowest N, where Highest and Lowest need a sort key).
  • Template mapping: the notification template that renders the released digest.
The Add to Digest node only collects. Releases happen when the topic’s schedule fires.

Digest Payload

When the digest releases, each category is delivered with the total count and the retained items:
{
  "[category_key]": {
    "count": 15,
    "items": [
      { "event": "data", "from": "first_event" },
      { "event": "data", "from": "second_event" }
    ]
  }
}
count is the total number of events received (it can exceed the retained count); items are the retained events. Reference this data in your digest template.

Via the API

In a journey definition, an Add to Digest node uses type: "add-to-digest":
{
  "type": "add-to-digest",
  "subscription_topic_id": "your-topic-id"
}
See Building Journeys via the API for the full node reference.

What’s Next

Batch

Release collected events by count or inactivity instead

Preferences

Configure subscription topics and digest schedules

Send

Render the digest payload in a template

Building Journeys via the API

Full node reference and definitions