Dispatch ID behavior
A dispatch_id is the ID of the message dispatch—a unique ID for each “transmission” sent from Braze. Users who are sent a scheduled message get the same dispatch_id, while action-based or API-triggered messages will receive a unique dispatch_id per user.
Note that dispatch_ids are per user, per campaign for triggered (action-based or API-triggered) messages.
This can result in two different users having different dispatch_ids for a single campaign if messages were sent at two different times. This is often because the API requests were made separately. If both users were in the same campaign audience in a single send, their dispatch_ids would be the same.
Dispatch ID behavior in campaigns
Scheduled campaign messages get the same dispatch_id. Action-based or API-triggered campaign messages will get a unique dispatch_id per user. For example, two users in your scheduled campaign audience will have the same dispatch_id. However, two users in the audience of an API-triggered campaign will have different dispatch_ids.
Multichannel campaigns will have the same behavior as described for their delivery type.
A dispatch_id is generated randomly for all Canvas Steps because Braze treats Canvas Steps as triggered events, even when they are “scheduled”. This may result in inconsistencies generating the IDs. Sometimes, a Canvas component will have unique dispatch_ids per user per send, or it may have shared dispatch_ids across users per send.
Template dispatch ID into messages with Liquid
If you want to track the dispatch of a message from within the message (in a URL, for example), you can template in the dispatch_id. You can find the formatting for this in our list of Supported Personalization Tags, under Canvas Attributes.
This behaves just like api_id, in that since the api_id isn’t available at campaign creation, it is templated in as a placeholder and will preview as dispatch_id_for_unsent_campaign. The ID is generated before the message is sent, and will be included in as send time.
Liquid templating of dispatch_id_for_unsent_campaign does not work with in-app messages, since in-app messages don’t have a dispatch_id.
Dispatch ID Currents field for email
In the effort to continue enhancing our Currents capabilities, we’re adding dispatch_id as a field to Currents email events across all connector types.
The dispatch_id is the unique ID generated for each transmission, or dispatch, sent from the Braze platform.
While all customers who are sent a scheduled message get the same dispatch_id, customers who receive either action-based or API-triggered messages will get a unique dispatch_id per message. The dispatch_id field enables you to identify which instance of a recurring campaign is responsible for conversion, thus equipping you with more insights and information on which types of campaigns are helping push the needle on your business goals.
You can use dispatch_id as a Personalization Tag, in Message Engagement Events, or when you use Segment, Mixpanel, or Amplitude for Currents.
Last updated on July 15, 2021
Edit this page on GitHub