From 6a671298480656bc2b427f392a38bcfa0ec6c84d Mon Sep 17 00:00:00 2001 From: Alec Guessous Date: Thu, 12 Jun 2025 16:39:26 +0200 Subject: [PATCH 1/4] Batch documentation --- .../destinations/catalog/batch/index.md | 100 ++---------------- 1 file changed, 10 insertions(+), 90 deletions(-) diff --git a/src/connections/destinations/catalog/batch/index.md b/src/connections/destinations/catalog/batch/index.md index 560aaef561..200280a450 100644 --- a/src/connections/destinations/catalog/batch/index.md +++ b/src/connections/destinations/catalog/batch/index.md @@ -1,101 +1,21 @@ --- title: Batch Destination -id: 596d11f870a3e552b957e6d9 --- -The Batch.com integration code is open sourced on GitHub. Feel free to check it out: [iOS](https://github.com/BatchLabs/ios-segment-integration){:target="_blank"}, [Android](https://github.com/BatchLabs/android-segment-integration){:target="_blank"}. -## Getting Started +{% include content/plan-grid.md name="actions" %} -* Batch.com supports the `screen`, `track`, `identify` and `group` methods. -* Make a Batch.com account. -* Turn on Batch.com using Segment dashboard. -* Enter your Batch LIVE API Key. You can find it in your dashboard, under 'settings'. +Batch is a powerful customer engagement platform that helps businesses deliver personalized, timely notifications and messages to boost user retention and drive growth. Discover how Batch can transform your communication strategy at Batch. -Events tracked using Segment's `track`/`screen` will automatically be tracked. `Identify` and `group` calls will also be mapped to Batch user data. +This destination is maintained by Batch. For any issues with the destination, [contact their Support team](mailto:support@batch.com). -## Android +## Getting started -### Installation +1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"} search for Batch. +2. Select **Batch** and click **Add Destination**. +3. Select an existing Source to connect to Batch (Actions). +4. Go to the [Batch dashboard](https://dashboard.batch.com/){:target="_blank"}, find and copy the **Project Key** / **REST API Key** +5. Enter the **Project Key** / **REST API Key** in the Batch destination settings in Segment. -Add the following dependency in your build.gradle: -``` -compile "com.batch.android:sdk-segment-integration:+" -``` - -Import the integration: - -``` -import com.segment.analytics.android.integrations.batch.BatchIntegration; - -``` - -Then, add the factory to your Analytics instance: - -```java -Analytics analytics = new Analytics.Builder(this, "write_key") - .use(BatchIntegration.getFactory(this)) - .build(); -``` - - -## iOS - -### Installation - -Add the following Cocoapods dependency: - -``` -pod 'Segment-Batch' -``` - -If you integrate in a Swift project or have `use_frameworks!` in your Podfile, you need to use the following to work around due to a limitation with Cocoapods: - -``` -pod 'Batch' -pod 'Segment-Batch/StaticLibWorkaround' -``` - -Then, add the integration factory in your Analytics instance: - -```objc -#import - -SEGAnalyticsConfiguration *config = [SEGAnalyticsConfiguration configurationWithWriteKey:@"MySegmentWriteKey"]; -[config use:[SEGBatchIntegrationFactory instance]]; -[SEGAnalytics setupWithConfiguration:config]; -``` - -## Server Side - -You can transmit server-side data from Segment to Batch with a [destination function](/docs/connections/functions/destination-functions/). Follow the steps outlined [in Batch's documentation](https://help.batch.com/en/articles/2208243-how-to-connect-batch-to-segment){:target="_blank"} for a smooth integration. - -## Screen - -When you call `screen` in your mobile app, we send a screen view to an event named `SEGMENT_SCREEN`. The screen name will be tracked as the event's label. - -## Identify - -When you `identify` a user, we'll pass that user's information to Batch as the custom user identifier. Batch supports tracking anonymous users, but not through Segment's `anonymousId`. - -Tracked events are attached to the installation ID, and the installation ID itself can be attached/detached to a user at a later date, with no data loss. - -## Track - -When you `track` an event, we will send that event to Batch after converting the name to fit Batch's event naming rules. - -For example, an event named `Ad Shown` will become `AD_SHOWN`. Note that this means that event names longer than 30 characters will be truncated. -The events `title` property will become the event's label. - -## Group - -When you call `group`, we will set the group ID in a user attribute named `SEGMENT_GROUP`. - -## Features - -All of our supported Segment integration features will work automatically, with no action or specific properties required on your side. - -Batch's other features are available directly by using the native SDK, which comes bundled with this integration. - -To use the Batch native SDK through Segment, follow the [instructions for Android](/docs/connections/sources/catalog/libraries/mobile/android/#how-can-i-use-a-destination-specific-feature) and [instructions for iOS](/docs/connections/sources/catalog/libraries/mobile/ios/#what-if-your-sdk-doesnt-support-feature-x). +{% include components/actions-fields.html %} From 7db8518e89cd4f270712d980c154b9ef7c34ffcd Mon Sep 17 00:00:00 2001 From: Sharon Adewusi Date: Tue, 24 Jun 2025 12:40:53 +0100 Subject: [PATCH 2/4] Update src/connections/destinations/catalog/batch/index.md --- src/connections/destinations/catalog/batch/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/batch/index.md b/src/connections/destinations/catalog/batch/index.md index 200280a450..7d463dd29b 100644 --- a/src/connections/destinations/catalog/batch/index.md +++ b/src/connections/destinations/catalog/batch/index.md @@ -5,7 +5,7 @@ title: Batch Destination {% include content/plan-grid.md name="actions" %} -Batch is a powerful customer engagement platform that helps businesses deliver personalized, timely notifications and messages to boost user retention and drive growth. Discover how Batch can transform your communication strategy at Batch. +Batch is a powerful customer engagement platform that helps businesses deliver personalized, timely notifications and messages to boost user retention and drive growth. For details on how Batch can transform your communication strategy, see [Batch.com](https://batch.com/platform){:target=_"blank"}. This destination is maintained by Batch. For any issues with the destination, [contact their Support team](mailto:support@batch.com). From 2c09ccbdd567483a28b5e7e48bd620554ff224c7 Mon Sep 17 00:00:00 2001 From: Sharon Adewusi Date: Tue, 24 Jun 2025 12:41:01 +0100 Subject: [PATCH 3/4] Update src/connections/destinations/catalog/batch/index.md --- src/connections/destinations/catalog/batch/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/batch/index.md b/src/connections/destinations/catalog/batch/index.md index 7d463dd29b..4b20c8ad09 100644 --- a/src/connections/destinations/catalog/batch/index.md +++ b/src/connections/destinations/catalog/batch/index.md @@ -13,7 +13,7 @@ This destination is maintained by Batch. For any issues with the destination, [c 1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"} search for Batch. 2. Select **Batch** and click **Add Destination**. -3. Select an existing Source to connect to Batch (Actions). +3. Select an existing source to connect to Batch (Actions). 4. Go to the [Batch dashboard](https://dashboard.batch.com/){:target="_blank"}, find and copy the **Project Key** / **REST API Key** 5. Enter the **Project Key** / **REST API Key** in the Batch destination settings in Segment. From 04003c301e014347dc9dd9d21210378a4326b086 Mon Sep 17 00:00:00 2001 From: Sharon Adewusi Date: Tue, 24 Jun 2025 12:41:07 +0100 Subject: [PATCH 4/4] Update src/connections/destinations/catalog/batch/index.md --- src/connections/destinations/catalog/batch/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/batch/index.md b/src/connections/destinations/catalog/batch/index.md index 4b20c8ad09..9b72545a4f 100644 --- a/src/connections/destinations/catalog/batch/index.md +++ b/src/connections/destinations/catalog/batch/index.md @@ -11,7 +11,7 @@ This destination is maintained by Batch. For any issues with the destination, [c ## Getting started -1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"} search for Batch. +1. From your workspace's [destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank"} search for "Batch". 2. Select **Batch** and click **Add Destination**. 3. Select an existing source to connect to Batch (Actions). 4. Go to the [Batch dashboard](https://dashboard.batch.com/){:target="_blank"}, find and copy the **Project Key** / **REST API Key**