event

Customer Engagement Recorded

Emitted when a customer interacts with a notification across any channel

EventNew

Overview

The CustomerEngagementRecorded event is emitted when a customer interacts with a notification. Interactions form a tree: a customer can open an email, click a link inside it, and then dismiss the in-app banner that the link opened. Each node in the tree is an Interaction that may contain child interactions, and carries channel-specific details for email, push, or SMS.

Schema

Event Details

  • Interaction Tree: root_interaction is the root node; children contain follow-up interactions triggered by it
  • Channel Details: Each interaction carries exactly one of email, push, or SMS specific details
  • Deduplication: Consumers should deduplicate using engagement_id
Event-driven architecture documentation: Acme Inc

CustomerEngagementRecorded Schema

23 fields
Package:com.ecommerce.notifications.engagement(proto3)
Message:CustomerEngagementRecorded

Emitted when a customer interacts with a notification. Interactions form a tree: a customer can open an email, then click a link inside it, then dismiss the in-app banner that the link opened. Each node in the tree is an Interaction that may contain child interactions.

engagement_idstring= 1
customer_idstring= 2
notification_idstring= 3

The notification that started this engagement

campaign_idstring= 4

Marketing campaign the notification belongs to, if any

root_interactionInteraction= 5

The root of the interaction tree

total_interactionsuint32= 6

Total nodes in the tree, for quick filtering

recorded_atstring= 7
Message:RecordEngagementResponse
acceptedbool= 1
deduplication_keystring= 2

Stable key consumers can use to deduplicate retries

Enum:Channel

The channel a notification was delivered on.

Allowed values: CHANNEL_UNSPECIFIED EMAIL SMS PUSH IN_APP
Edit this page