Skip to content

[C-20381][C-20504] Document journey send-status conditions and the digest template dependency #192

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
mikemilla merged 1 commit into from
Sep 8, 2026
Merged

[C-20381][C-20504] Document journey send-status conditions and the digest template dependency #192

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
6 changes: 5 additions & 1 deletion src/courier/types/journey_node.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,11 @@ class JourneyBatchNode(BaseModel):
class JourneyAddToDigestNode(BaseModel):
"""Add the current event to a digest keyed by the given subscription topic.

The digest accumulates events and releases them on the schedule configured for the topic.
The digest accumulates events and releases them on the schedule configured for the topic, using the notification template configured on that topic.

**The topic must have a template configured.** If the topic has no template when the first event reaches this node, the journey run fails immediately: the run is marked `ERROR`, no digest instance is created, and the journey does not continue past this node. Configure the topic's template before using the topic in a journey.

If the journey run is scoped to a tenant, digests are kept separate per tenant: two runs for the same user under different tenants accumulate and release as separate digests, even on the same topic.
"""

subscription_topic_id: str
Expand Down
6 changes: 5 additions & 1 deletion src/courier/types/journey_node_param.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,11 @@ class JourneyBatchNode(TypedDict, total=False):
class JourneyAddToDigestNode(TypedDict, total=False):
"""Add the current event to a digest keyed by the given subscription topic.

The digest accumulates events and releases them on the schedule configured for the topic.
The digest accumulates events and releases them on the schedule configured for the topic, using the notification template configured on that topic.

**The topic must have a template configured.** If the topic has no template when the first event reaches this node, the journey run fails immediately: the run is marked `ERROR`, no digest instance is created, and the journey does not continue past this node. Configure the topic's template before using the topic in a journey.

If the journey run is scoped to a tenant, digests are kept separate per tenant: two runs for the same user under different tenants accumulate and release as separate digests, even on the same topic.
"""

subscription_topic_id: Required[str]
Expand Down