Message engagement events

Agent executed events

This is the Kafka record schema for when an Agent Console agent is executed.

• cloud storage
• custom http connector

Tool invocation events

This is the Kafka record schema for when a tool is executed. A tool is a function given to an LLM to fulfill an objective.

• cloud storage
• custom http connector

Uninstall events

This event occurs when a user uninstalls an app. Use this data to track when users uninstall an app. While this is currently a message engagement event, this will be changed to a user behavior event in the future.

important

This event is not fired when the user actually uninstalls the app, as that’s impossible to track exactly. Braze sends a daily silent push to determine if the app still exists on your user’s device, and if we get an error on that silent push, it is assumed the app has been uninstalled.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Global Subscription State Change events

This event occurs when Braze receives a request to update the global subscription state of the user.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• state_change_source will return a string of the full source name. For example, the source CSV import will return the string CSV Import. Available sources are listed below:

Subscription Group State Change events

This event occurs when the subscription state of a user in a subscription group changes.

important

Subscription groups are only available for email, SMS, RCS, and WhatsApp channels at this time.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
• state_change_source returns a string of the full source name. For example, the source CSV import will return the string CSV import. Available sources are listed below:

Campaign Conversion events

This event occurs when a user does an action that has been set as a conversion event in a campaign.

important

Note that the conversion event is encoded in the conversion_behavior field, which includes the type of conversion event, the window (timeframe), and additional information depending on the conversion event type. The conversion_behavior_index field represents which conversion event, such as 0 = A, 1 = B, 2 = C, 3 = D.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Campaign Control Group Enrollment events

This event occurs when a user is enrolled in a control variant set on a multi-variant campaign. This event is generated as there will be no channel send event for this user.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Canvas Conversion events

This event occurs when a user does an action that has been set as a conversion event in Canvas.

important

Note that the conversion event is encoded in the conversion_behavior field, which includes the type of conversion event, the window (timeframe), and additional information depending on the conversion event type. The conversion_behavior_index field represents which conversion event, such as 0 = A, 1 = B, 2 = C, 3 = D.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Canvas Entry events

This event occurs when a user enters into the Canvas. This event tells you which variant the user entered into.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Exit Match Audience events

This event occurs when a user has exited a Canvas by matching an audience.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Exit Perform Event events

This event occurs when a user has exited a Canvas by performing an event.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Experiment Step Conversion events

This event occurs when a user converts for a Canvas experiment step.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Experiment Split Entry events

This event occurs when a user enters a Canvas experiment step path.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Canvas Step Progression events

This event occurs when a user progresses through a step in a Canvas with some outcome. Note that this event doesn’t occur when steps are entered or exited. Currently, only split steps (Audience Paths, Decision Split, Action Paths, Experiment) and advance outcomes generate step progression events.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Banner Abort events

This event occurs when an originally scheduled banner message was aborted for some reason.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• The abort_type field describes the reason the message was aborted. For a full list of values, see Abort types.
• abort_type will be frequency_capped if the message was aborted due to a global frequency cap rule.
• abort_log includes information about the specific rule that triggered the abort. An example is: Frequency cap rule: 5 Banner messages every 1 week

Banner Click events

This event occurs when a user clicks a banner.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Banner Dismissal events

This event occurs when a user dismisses a banner.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Banner Impression events

This event occurs when a user views a banner.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Content Card Abort events

This event occurs if a Content Card message was aborted based on Liquid aborts, etc.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
• The abort_type field describes the reason the message was aborted. For a full list of values, see Abort types.
• abort_type will be frequency_capped if the message was aborted due to a global frequency cap rule.
• abort_log includes information about the specific rule that triggered the abort. An example is: Frequency cap rule: 5 Content Card messages every 1 week

Content Card Click events

This event occurs when a user clicks a Content Card.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• For ad_id, ad_id_type, and ad_tracking_enabled, you need to explicitly collect the iOS IDFA and Android Google advertising ID through the native SDKs. Learn more about this setup for iOS and Android.
• If you’re using Kafka to ingest Currents data, contact your customer success manager to enable sending ad_id.

Content Card Dismiss events

This event occurs when a user dismisses a Content Card.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• For ad_id, ad_id_type, and ad_tracking_enabled, you need to explicitly collect the iOS IDFA and Android Google advertising ID through the native SDKs. Learn more about this setup for iOS and Android.
• If you’re using Kafka to ingest Currents data, contact your customer success manager to enable sending ad_id.

Content Card Impression events

This event occurs when a user views a Content Card.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• For ad_id, ad_id_type, and ad_tracking_enabled, you need to explicitly collect the iOS IDFA and Android Google advertising ID through the native SDKs. Learn more about this setup for iOS and Android.
• If you’re using Kafka to ingest Currents data, contact your customer success manager to enable sending ad_id.

Content Card Send events

This event occurs when a Content Card gets sent to a user.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• message_extras allow you to annotate your send events with dynamic data from Connected Content, custom attributes (such as language or country), and Canvas entry properties. Refer to Message extras to learn more.

Email Abort events

This event occurs if an email message was aborted based on Liquid aborts, etc.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
• The abort_type field describes the reason the message was aborted. For a full list of values, see Abort types.
• abort_type will be frequency_capped if the message was aborted due to a global frequency cap rule.
• abort_log includes information about the specific rule that triggered the abort. An example is: Frequency cap rule: 5 email messages every 1 week

Email Bounce events

This event occurs when an Internet Service Provider returns a hard bounce. A hard bounce signifies a permanent deliverability failure.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
  • The behavior for dispatch_id differs between Canvas and campaigns because Braze treats Canvas steps (except for entry steps, which can be scheduled) as triggered events, even when they are scheduled. For more information, see Dispatch ID behavior.

Email Click events

This event occurs when a user clicks an email. Multiple events may be generated for the same campaign if a user clicks multiple times or clicks different links within the email.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment
• shopify

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
  • The behavior for dispatch_id differs between Canvas and campaigns because Braze treats Canvas steps (except for entry steps, which can be scheduled) as triggered events, even when they are scheduled. For more information, see Dispatch ID behavior.

Email Deferral events

This event occurs when an Internet Service Provider does not immediately deliver the email to a non-hard bounced email address and Braze retries the email for up to 72 hours. Typical reasons for deferrals include reputation-based email volume rate-limiting from the inbox provider, temporary connectivity issues, recipient’s mailbox is full, or DNS errors.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
  • The behavior for dispatch_id differs between Canvas and campaigns because Braze treats Canvas steps (except for entry steps, which can be scheduled) as triggered events, even when they are scheduled.

Email Delivery events

This event occurs when an email sent made it successfully to the end-users inbox.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
  • The behavior for dispatch_id differs between Canvas and campaigns because Braze treats Canvas steps (except for entry steps, which can be scheduled) as triggered events, even when they are scheduled.

Email Mark As Spam events

This event occurs when the end-user hits the “spam” button on the email. Note that this does not represent the fact the email went into the spam folder as Braze does not track this.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
  • The behavior for dispatch_id differs between Canvas and campaigns because Braze treats Canvas steps (except for entry steps, which can be scheduled) as triggered events, even when they are scheduled.

Email Open events

This event occurs when a user opens an email. Multiple events may be generated for the same campaign if a user opens the email multiple times.

important

It’s known behavior that the email open event fields device_model and mailbox_provider are empty. You can ignore these for now.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment
• shopify

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
  • The behavior for dispatch_id differs between Canvas and campaigns because Braze treats Canvas steps (except for entry steps, which can be scheduled) as triggered events, even when they are scheduled.

Email Retry events

This event occurs when a message is deprioritized or frequency capped and will be retried later within the configured retry window. This is only available for Message Prioritization beta customers.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Email Send events

This event occurs when an email send request was successfully communicated between Braze and SendGrid. However, this does not mean the email was received in the user’s inbox. Braze does not log events to user profiles or any Currents destination (such as Snowflake) if the event cannot be matched to both the email and user ID associated with the email event.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment
• shopify

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
  • The behavior for dispatch_id differs between Canvas and campaigns because Braze treats Canvas steps (except for entry steps, which can be scheduled) as triggered events, even when they are scheduled. For more information, see Dispatch ID behavior.
• message_extras allow you to annotate your send events with dynamic data from Connected Content, custom attributes (such as language, country), and Canvas entry properties. Refer to Message extras to learn more.

Email Soft Bounce events

This event occurs when an Internet Service Provider returns a soft bounce. A soft bounce signifies that an email could not be delivered because of a temporary deliverability failure.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
  • The behavior for dispatch_id differs between Canvas and campaigns because Braze treats Canvas steps (except for entry steps, which can be scheduled) as triggered events, even when they are scheduled. For more information, see Dispatch ID behavior.

Email Unsubscribe events

This event occurs when the end-user has clicked “unsubscribe” from the email.

important

The Unsubscribe event is considered a specialized click event that is fired when your user clicks the unsubscribe link in the email (either a normal unsubscribe link within the email body or footer, or using the list-unsubscribe header), not when the user changes state to unsubscribed. If subscription state change is sent through the API, or with a custom (non-Braze) unsubscribe link, it does not trigger an email unsubscribe event on Currents.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
  • The behavior for dispatch_id differs between Canvas and campaigns because Braze treats Canvas steps (except for entry steps, which can be scheduled) as triggered events, even when they are scheduled. For more information, see Dispatch ID behavior.

Feature Flag Experiment Impression events

This event occurs whenever a user has had an opportunity to interact with your feature, or when they could have interacted if the feature is disabled (in the case of a control group in an A/B test).

Feature flag impressions are only logged once per session.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

In-App Message Abort events

This event occurs when an originally scheduled in-app message was aborted.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• The abort_type field describes the reason the message was aborted. For a full list of values, see Abort types.
• abort_type will be frequency_capped if the message was aborted due to a global frequency cap rule.
• abort_log includes information about the specific rule that triggered the abort. An example is: Frequency cap rule: 5 in-app messages every 1 week

In-App Message Click events

This event occurs when a user clicks an in-app message.

note

For in-app messages, dispatch_id returns null.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• For ad_id, ad_id_type, and ad_tracking_enabled, you need to explicitly collect the iOS IDFA and Android Google advertising ID through the native SDKs. Learn more about this setup for iOS and Android.
• If you’re using Kafka to ingest Currents data, contact your customer success manager to enable sending ad_id.

In-App Message Impression events

This event occurs when a user views an in-app message.

note

For in-app messages, dispatch_id returns null.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• For ad_id, ad_id_type, and ad_tracking_enabled, you need to explicitly collect the iOS IDFA and Android Google advertising ID through the native SDKs. Learn more about this setup for iOS and Android.
• If you’re using Kafka to ingest Currents data, contact your customer success manager to enable sending ad_id.

LINE Abort events

This event occurs when a scheduled LINE message cannot be delivered, before sending to LINE.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
• The abort_type field describes the reason the message was aborted. For a full list of values, see Abort types.
• abort_type will be frequency_capped if the message was aborted due to a global frequency cap rule.
• abort_log includes information about the specific rule that triggered the abort. An example is: Frequency cap rule: 5 LINE messages every 1 week

LINE Click events

This event occurs when a user clicks a link in a LINE message where the link’s domain matches the click tracking domain.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

LINE Inbound Receive events

This event occurs when a LINE message is received from a user.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

LINE Retry events

This event occurs when a message is deprioritized or frequency capped and will be retried later within the configured retry window. This is only available for Message Prioritization beta customers.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

LINE Send events

This event occurs when a LINE message is sent to LINE.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

Live Activity Outcome events

This event occurs when Braze receives a response from a third party provider (e.g. APNs) after the Live Activity send

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Live Activity Send events

This event occurs when the Braze system makes a request to its provider regarding Live Activity.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Push Notification Abort events

This event occurs if a push notification message was aborted based on Liquid aborts, etc.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
• The abort_type field describes the reason the message was aborted. For a full list of values, see Abort types.
• abort_type will be frequency_capped if the message was aborted due to a global frequency cap rule.
• abort_log includes information about the specific rule that triggered the abort. An example is: Frequency cap rule: 5 push messages every 1 week

Push Notification Bounce events

This event occurs when an error is received from either Apple Push Notification Service or Fire Cloud Messaging. This means that the push message was bounced, and therefore not delivered to the user’s device.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• If you’re using Kafka to ingest Currents data, contact your customer success manager or account manager to enable the feature flipper for sending ad_id.
• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

Push Notification iOS Foreground Open events

This event is not supported by our Swift SDK and is now deprecated using our Obj-C SDK.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• segment

Property details

• For ad_id, ad_id_type, and ad_tracking_enabled, you need to explicitly collect the iOS IDFA and Android Google advertising ID through the native SDKs. Learn more about this setup for iOS and Android.
• If you’re using Kafka to ingest Currents data, contact your customer success manager to enable sending ad_id.
• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

Push Notification Open events

This event occurs when a user directly clicks on the push notification to open the application. Currently, Push Open Events refer specifically to “Direct Opens” rather than “Total Opens”. This does not include statistics shown at the campaign level of “influenced opens” as these are not attributed at the user level.

note

In rare cases, a push open may appear before the corresponding push send event in Currents data because of the following:

• Your SDK has an incorrect clock.
• High batch write latency. The recorded send time can lag behind early deliveries, so very quick opens may be logged before the batch’s final send timestamp is written. Large sends are dispatched and recorded in batches.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• For ad_id, ad_id_type, and ad_tracking_enabled, you need to explicitly collect the iOS IDFA and Android Google advertising ID through the native SDKs. Learn more about this setup for iOS and Android.
• If you’re using Kafka to ingest Currents data, contact your customer success manager to enable sending ad_id.
• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

Push Notification Retry events

This event occurs when a message is deprioritized or frequency capped and will be retried later within the configured retry window. This is only available for Message Prioritization beta customers.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Push Notification Send events

This event occurs when Braze processes a push message for a user, communicating this to Apple Push Notification Service or Fire Cloud Messaging. This does not mean the push was delivered to the device, just that a message was sent.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• For ad_id, ad_id_type, and ad_tracking_enabled, you need to explicitly collect the iOS IDFA and Android Google advertising ID through the native SDKs. Learn more about this setup for iOS and Android.
• If you’re using Kafka to ingest Currents data, contact your customer success manager to enable sending ad_id.
• message_extras allow you to annotate your send events with dynamic data from Connected Content, custom attributes (such as language, country), and Canvas entry properties. Refer to Message extras to learn more.
• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

RCS Abort events

This event is created when an RCS send is interrupted due to an error detected within Braze, and the message is dropped.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• The abort_type field describes the reason the message was aborted. For a full list of values, see Abort types.
• abort_type will be frequency_capped if the message was aborted due to a global frequency cap rule.
• abort_log includes information about the specific rule that triggered the abort. An example is: Frequency cap rule: 5 RCS messages every 1 week

RCS Click events

An event that is created when the user interacts with an RCS message in a way that involves tapping or clicking on a UI element.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

RCS Delivery events

This event is created when an RCS message is successfully delivered to a user’s mobile device.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

RCS Inbound Received events

This event is created when Braze receives an RCS message that originates from the user.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

RCS Read events

This event is created when a user opens an RCS message on their device, indicating that they have seen or read the message content.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

RCS Rejection events

An event that is created when an RCS message fails to be delivered to a user’s mobile device due to intervention by the carrier.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

RCS Send events

This event is created when an RCS message is sent out of Braze to our last-mile delivery partners.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

SMS Abort events

This event occurs if an SMS message was aborted based on Liquid aborts, etc.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• The abort_type field describes the reason the message was aborted. For a full list of values, see Abort types.
• abort_type will be frequency_capped if the message was aborted due to a global frequency cap rule.
• abort_log includes information about the specific rule that triggered the abort. An example is: Frequency cap rule: 5 SMS messages every 1 week

SMS Carrier Send events

This event occurs when an SMS is sent to the carrier.

important

CarrierSend is supported only for users on legacy infrastructure.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

SMS Delivery events

This event occurs when an SMS was successfully delivered to the user’s mobile phone.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

SMS Delivery Failure events

This event occurs when an SMS experiences delivery failure. Use this event and the provided error codes to help troubleshoot issues with SMS delivery.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

SMS Inbound Received events

This event occurs when one of your users sends an SMS to a phone number in one of your Braze SMS subscription groups.

When Braze receives an inbound SMS, we attribute that inbound message to any user that shares that phone number. As a result, you may receive multiple events per inbound message if multiple users in your Braze instance share the same phone number. If you require attribution of specific user IDs based on previous messages sent to that user, you can use the SMS Delivered event to attribute Inbound Received events to the user ID who most recently received a message from your Braze number.

If we detect that this inbound message is a reply to an outbound campaign or Canvas component sent from Braze, we will also include the campaign or Canvas metadata with the event. Braze defines a reply as an inbound message coming within four hours of an outbound message. However, there is a one-minute cache for the attributed campaign information of the last outbound SMS received.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

SMS Rejection events

This event occurs when an SMS send gets rejected by the carrier. This can happen for several reasons. Use this event and the provided error codes to help troubleshoot issues with SMS delivery.

note

Braze emits users.messages.sms.Rejection to Currents, Snowflake Data Sharing, and related exports only when the Braze user profile still exists in the workspace when the event is processed for logging. If that profile was deleted beforehand, you won’t see this event in your warehouse or Currents export. The same processing rule applies to other users.messages.sms.* outbound events Braze logs through the same pipeline (for example delivery, delivery failure, and sent-to-carrier). Workspace-level SMS metrics can still include aggregate counts that don’t map one-to-one to rows in Snowflake.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

SMS Retry events

This event occurs when a message is deprioritized or frequency capped and will be retried later within the configured retry window. This is only available for Message Prioritization beta customers.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

SMS Send events

This event occurs when a user sends an SMS.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment
• shopify

Property details

• message_extras allow you to annotate your send events with dynamic data from Connected Content, custom attributes (such as language, country), and Canvas entry properties. Refer to Message extras to learn more.
• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

SMS Short Link Click events

This event occurs when a user clicks an SMS short link.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment
• shopify

Webhook Abort events

This event occurs if a webhook message was aborted based on Liquid aborts, etc.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
• The abort_type field describes the reason the message was aborted. For a full list of values, see Abort types.
• abort_type will be frequency_capped if the message was aborted due to a global frequency cap rule.
• abort_log includes information about the specific rule that triggered the abort. An example is: Frequency cap rule: 5 webhook messages every 1 week

Webhook Failure events

This event occurs if a webhook message was delivered but failed with an error response from the endpoint.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

Webhook Retry events

This event occurs when a message is deprioritized or frequency capped and will be retried later within the configured retry window. This is only available for Message Prioritization beta customers.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Webhook Send events

This event occurs when a webhook was processed and sent to the third party specified in that webhook. Note that this does not signify whether or not the request was received.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• message_extras allow you to annotate your send events with dynamic data from Connected Content, custom attributes (such as language or country), and Canvas entry properties. Refer to Message extras to learn more.
• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

WhatsApp Abort events

This event occurs if a WhatsApp message was aborted based on Liquid aborts, etc.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).
• The abort_type field describes the reason the message was aborted. For a full list of values, see Abort types.
• abort_type will be frequency_capped if the message was aborted due to a global frequency cap rule.
• abort_log includes information about the specific rule that triggered the abort. An example is: Frequency cap rule: 5 WhatsApp messages every 1 week

WhatsApp Tracked Link Click events

This event occurs when a user clicks a link or button in a WhatsApp message where the link’s domain matches the click tracking domain.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

WhatsApp Delivery events

This event occurs when an WhatsApp message sent made it successfully to the user’s device.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

WhatsApp Failure events

This event occurs when WhatsApp cannot deliver the message to the user. A hard bounce signifies a permanent deliverability failure.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

WhatsApp Inbound Received events

This event occurs when one of your users sends a WhatsApp message to a phone number in one of your Braze WhatsApp subscription groups.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

WhatsApp Read events

This event occurs when an WhatsApp message is read by the user.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

WhatsApp Retry events

This event occurs when a message is deprioritized or frequency capped and will be retried later within the configured retry window. This is only available for Message Prioritization beta customers.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

WhatsApp Send events

This event occurs when a send request was successfully communicated between Braze and WhatsApp. Though, this does not mean the message was received by the user.

• cloud storage
• amplitude
• custom http connector
• mixpanel
• mparticle
• segment

Property details

• dispatch_id is an ID for a specific message dispatch, such as a campaign send. All push events that originate from the same dispatch include the same dispatch_id. Use dispatch_id to group events that belong to the same dispatch, allowing you to group and correlate the push message lifecycle for that dispatch (such as Send, Bounce, and Open).

User Profile Update events

This represents the profile updates for a user.

• cloud storage