Batch (Actions) Destination

1. From your workspace's destinations catalog, search for Batch.
2. Select Batch (Actions) and click Add Destination.
3. Choose the source you want to connect to Batch (Actions).
4. In the Batch dashboard, copy your Project Key and REST API Key.
5. Paste the Project Key and REST API Key into the Batch destination settings in Segment.
6. Toggle Enable Destination. Segment will start sending data to Batch according to your Mappings.

Expand image

Batch (Actions) has the following presets

Build your own Mappings. Combine supported triggers with the following Batch-supported actions:

• Update User Profile

Sends user events or creates and updates user profiles in Batch.

Update User Profile is a Cloud action. The default Trigger is type = "identify" or type = "track"

When you call Identify, Segment maps userId to identifiers.custom_id and writes traits into attributes.

Notes

• $email_marketing / $sms_marketing: use subscribed / unsubscribed.
• A locale like fr-FR is split into language (fr) and region (FR).
• All other non‑reserved fields become custom attributes under attributes (strings, numbers, booleans, arrays of strings). Avoid arbitrary nested objects.

To map additional traits into Batch profile attributes:

1. Open your destination → Mappings → Edit Mapping.

2. Go to Profile attributes → Add Mapping Field.

3. Choose a source (for example, traits.plan) and set a target under attributes (for example, attributes.plan).

   Expand image

4. In Step 4 – Send test record, you can test your mapping before saving.

   Expand image

5. Save and enable the mapping.

If you want to integrate your entire Segment userbase into Batch using the Identify method, you can request a historical backfill from Segment.

To do this:

1. Contact Segment Support at friends@segment.com.
2. Request a historical replay of your data.
3. Provide Segment with the following details:
   • Start date and time
   • End date and time (usually "now")
   • Source: the Segment source you want to replay
   • Destination: Batch (Actions)
   • Events: Identify

Segment will then replay your historical data so Batch can import your full userbase.

When you call Track, Segment uses your userId as Batch's identifiers.custom_id. A userId is required to attribute the event to a profile.

1
{
2
  "identifiers": {
3
    "custom_id": "97980cfea0067"
4
  },
5
  "event": {
6
    "name": "User Registered",
7
    "attributes": {
8
      "plan": "Pro Annual",
9
      "accountType": "Facebook"
10
    }
11
  }
12
}

Events are sent to Batch in near real time according to your destination mappings, and all event properties are included under event.attributes.

Expand image

• Always send a stable userId → becomes identifiers.custom_id.
• Place native profile fields under attributes: $email_address, $email_marketing, $phone_number, $sms_marketing, $language, $region, $timezone.
• Put everything else under custom attributes in attributes.
• Format dates using ISO‑8601 UTC (for example: 1989-07-20T00:00:00Z).
• Configure additional mappings in Mappings → Edit Mapping.
• Test with a read-back or export to verify types, encodings, and timezones.

To integrate a computed trait with Batch:

1. Go to your Segment workspace.
2. Open the Engage tab → Destinations.
   • If your Batch destination is already listed, skip this step.
   • Otherwise, click Add destination and select Batch (Actions).
3. Open the Engage tab → Audiences → Computed traits.
4. Click Create computed trait.
5. Configure your calculation method (for example: count, aggregation, last value).
6. Click Preview, then Next.
7. Select your Batch destination.
8. Choose how to send the data:
   • For an attribute → enable Send Identify in the connection settings.
   • For an event → enable Send Track.
9. Give your computed trait a clear name.

Segment will then automatically update and forward your computed trait data to Batch.

You can send computed traits and audiences generated using Engage to this destination as a user property. To learn more about Engage, schedule a demo.

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it's been more than 30 days since their last order), Engage sets that value to false.

When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

Segment lets you change these destination settings from the Segment app without having to touch any code.