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 send a scheduled message get the same dispatch_id, while action-based or API-triggered messages will receive a unique dispatch_id per user.

These 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.

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.

Multi-channel Campaigns will have the same behavior as described above.

For example, if Becky and Tom are both included in your scheduled Campaign audience, then they will have the same dispatch_id.

If they are included in the audience of an API-triggered Campaign, they will have different dispatch_ids.

More on Using Dispatch ID

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.

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.

WAS THIS PAGE HELPFUL?
New Stuff!