Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Settings regroup all the elements that should be setup properly, to be able to orchestrate the greatest engagement strategies.
Team access page allows the management of user permissions within Batch.
The administator can manage rights of other users.
Various rights described in Batch allow granularity in what users can do within Batch.
In-App templates are utilized in In-App messaging within the Batch platform. They provide a structured framework for orchestrating in-app and mobile landing engagement strategies.
A template defines the structure of an in-app message, not its specific content. For further details on template functionality, refer to the section of the documentation.
About content visualization, note that during template editing, text and images can be included for visualization purposes. This content is not saved with the template. Specific content is added when a message is created using the template.
The In-App templates page offers the following capabilities:
Create templates: New templates can be created from scratch or based on existing templates.
Rename templates: Custom templates can be renamed.
Delete templates: Custom templates can be deleted.
Search templates: Templates can be located using the search function.
Modify templates: Existing templates can be modified and saved as a new template or by overwriting the current version.
Manage team allows full coordination of your team work on Batch.
Batch lets you set specific permissions at the user-level to facilitate team collaboration.
There are several permissions you can grant or revoke:
Administrate: Grants full access to company account (team members, users permissions, etc). Note: an account can have more than one Administrator.
Review: Grants read-only access to the dashboard. Review users will not be able to create nor edit orchestrations.
App: Grants users rights to edit and manage apps.
Campaign: Grants users rights to create, edit and delete campaigns and automations.
Privacy: Grants users rights to manage GDPR settings.
To facilitate collaborative work, a user with "Administrate" rights can grant another user access to specific projects. This is useful if you want to make sure specific users cannot access all the project on the dashboard.
The user will have the same permissions on all the assigned projects.
Here are some suggestions to find the issue:
Check your spam folder and look for an email sent by hello@batch.com.
Resend the invite: Ask the administrator of Batch account to double-check the email address they used or resend the invite.
Validation link: If none of the above work, your manager can send you the confirmation link he will see after inviting you.
If one of your teammates already has a Batch account registered with his email address, he needs to contact our support team (support@batch.com) with the following information:
Email address of his first account.
Email address of the team he wants to join.
We will add him to your team with all the apps he created with his previous account.
You cannot manage more than one account with the same email address.
If you have a Gmail account or use Google Apps, you can add a "+" at the end of your username to benefit from dynamic alias (e.g. andrew+secondaccount@gmail.com).
Just ask us to delete your account at support@batch.com. Our team will let you know when it's done.
This is where brands brands manage their GDPR settings and can see Data Processing Agreement document.
Labels have two main purposes:
Marketing pressure limit: You can set a specific marketing pressure limit on all the campaigns attached to the same label (e.g. no more than 1 push a week for all campaigns using the "onboarding campaigns" label).
Filtering: You can filter the list of your campaigns based on the labels attached to your campaigns (e.g. "onboarding campaigns"):
That settings section contains basic information about your project, app or website.
Required - Name of your app or project. You can defined it freely. The icon will be automatically defined based on apps and website part of the project.
The icon is automatically deduced from the apps part of your project.
The project key is used to leverage Batch APIs by specifying the project you want to work on.
If you need to manage development, staging and production environments separately, you can create separate projects on the dashboard and rename them accordingly (e.g. [DEV] MyProject, [PROD] MyProject, etc).
Required - Name of your app or website. Batch will prefill that field based on the information gathered from the App Store, the Play Store or the metadata of your website. This name is not visible in the Dashboard, only the project name is.
Required, Web only - The URL of your website. Batch uses that URL to get the name and the icon of your website. Batch also uses your website URL to generate the SDK Auth key.
Required, iOS/Android only - Platform or framework used to develop your app. You can choose between iOS/Android (Native), Cordova, React Native, Flutter. Modifying that parameter will adjust the integration steps.
Here you can see the list of all the IDs needed to leverage our APIs, SDKs integrate the SDK or implkement the Inbox.
Batch generates an SDK API key for every app and website added to your company. The SDK API key identifies your website or your app on a specific platform. For example, you will notice your iOS app, your Android app and your website don't have the same SDK API key.
The SDK API key has two purposes:
APIs: The SDK API key is the unique reference to your website or your app on a specific platform when you call Batch REST APIs.
Integration: The SDK API key authenticates the requests sent to Batch servers and allows Batch to attach the data to the right app or website.
The REST API key authenticates the calls made to Batch APIs targeting your apps/websites API keys.
The REST API key is sensitive information as it allows you to send push notifications, display In-App messages, send data, and more from Batch APIs. Do not expose it to your users and avoid sharing it in your company. Batch only generates one valid REST API key per company.
If you suspect your REST API key is compromised, send an email to support@batch.com describing the issue. Our team will invalidate the REST API key and generate a new one after receiving validation from a user with the "administrate" right.
The Inbox secret key is the authentication key required to use the Inbox feature in your app.
You can create as many labels as you want. Every label you create has:
A code: Unique id of a label. Use it as a reference in your calls to the Batch API. Avoid editing label codes. By changing a label's code, you might trigger errors on your API calls if you don't update them with the new name. This may also reset the frequency capping limits on running campaigns already using this label.
A name: Used to identify your label on the dashboard.
You can edit the code and the name of existing labels or delete them if needed. Batch shows the number of orchestrations attached to each label so you can understand the impact of deleting or modifying one.
Frequency capping allows you to limit the number of messages a profile can receive in a certain time frame.
You can create a frequency capping for all the orchestrations attached to a specific labels. It works for orchestrations created via the Dashboard or Batch's APIs.
Batch dynamically checks the number of messages across all channels (email, SMS, push) that have been sent in the last X hours/days to see if the message has to be sent or not.
If you send a multiplatform push message, it counts as one sending even if the person might receive the push on several devices.
Important note: Messages sent very closely or at the same time may not be taken into account by the capping feature.
You can either define a simple limit that will be applied to all the notifications you send or fine-tune your global frequency capping:
All push notifications: The capping rules affects all your push notifications.
Orchestrations: The capping rules only affects notifications coming from campaigns and automations created on the dashboard or with the Campaign API.
Transactional: The capping rules only affects notifications sent with the Transactional API.
In-app messages: This capping rules only affects In-app messages. It can be setup by session or interval of time.
All these rules can work together. For example, you can set a global capping of 5 push notifications per day and create two additional rules that will ensure users won't receive more than 1 transactional push every 2 hours and 1 push from a marketing campaign per week.
You can see the number of messages that were not delivered because users already reached the limit defined in your dashboard settings. The corresponding metric is called "Skipped".
Plans & Billing allows users to monitor volumes of message sent and Monthly Active profiles (MAPs) by Project.
You can edit your account settings by expanding the menu in the top right corner, clicking on your initials.
Allows you to edit basic information about your account such as your first name, last name and the email address used to login.
If the Single Sign-On (SSO) feature is disabled, you can edit here the settings related to the security of your account. Otherwise, you will see "Your security settings are managed by your organization".
Use that part of the settings to change your password. If you don't remember your password, log our request for a password reset .
You can easily enable/disable Two Factor Authentication (2FA).
2FA adds an extra layer of security to your dashboard by asking for an auto-generated code from a second device each time you login. This protects your account in case your password is compromised.
Once enabled, Batch will generate a QR Code you will be able to scan with an authentication app and provide a list of recovery codes.
Make sure you print or save your recovery codes as this will be the only way to restore access to your account.
Account administrators can require new and existing teammates to use two-factor authentication (2FA) when they sign into Batch.
Account administrators can reset the API key if needed, for example if it leaked in a chat conversation, by mistake. All services leveraging Batch APIs will have to get the new key after the reset.
You will find here all the settings related to your different channels.
Email settings is where you setup email senders, such as "coupons@company.com".
The latter part of the email sender (e.g.: "@company.com") is setup a implementation time with Batch teams, and associated to one of the sender types defined below.
You can freely define the first part of the email sender (e.g.: "coupons") in this Settings section.
Three sender types exist:
Marketing: senders used for marketing purposes, such as email blasts and promotional campaigns.
Transactional: senders used for transactional purposes, such as account creation or purchase confirmation.
All: senders that can be used for both purposes. This is mostly useful for pre-production / testing purposes.
These senders type are linked to different IP ranges. This is made to make sure deliverability is optimal, especially for transactional messages.
When you will create a marketing or transactional orchestration, senders will filters based on their types.
Also, when you send a campaign via the Campaign API, you can specify the sender you want to use bases on the sender ID visible on this page.
You can specify the number of email messages to be sent per minute to protect your app or website architecture.
Even tough the Send rate is different for Push and Email, it operates identically (the default value is different but the functional logic is identical). Check a bit further down this page.
You will find here all the settings related to push notifications, from uploading your iOS certificate, editing your FCM IDs to editing the push delivery speed.
Separate settings apply to Push v1 and Push v2, and you will find a dedicated section for each in the interface:
You will find the Push V2 settings in a ‘Push’ tab in the Channels settings.
And the Push V1 settings via the ‘more’ dropdown in the top right-hand corner of the Channels settings.
Note that :
The section on test devices has not been reproduced on the push V2 settings.
Push configurations operate identically for both Push V1 and Push V2, as do the following settings: priority, expiration TTL, and collapse key.
The only difference is that the push V2 default Orchestrations settings (TTL, priority, Collapse key) are common to the different platforms (IOS, Android, Web).
Managing message sending speed works differently between Push V1, where the feature is called
To learn more about Push V1 settings, check .
On iOS, Batch servers need to have a valid certificate to communicate with Apple Push Notification Services (APNS). There are two types of files you can use:
p8 files (recommended): Valid for all the apps added to your Apple developer account. You will need to specify the Application Identifier (App ID) or the Bundle ID of your app on Batch's dashboard.
p12 certificates: Generated for a unique App ID and are only valid for one year.
If you are using a p8 file, here are the fields you will need to fill in:
App ID / Bundle ID / Topic: We recommend you use the bundle ID you will find in Xcode. You can also use the app ID available from the .
Team ID: The team ID is also available from the .
Basic Setup
On Android, Batch needs a Service Account Key issued from your Firebase project to send notifications. Service Account Keys can be generated from the .
Once you are logged in, select your project then click the ⚙ next to your project name and "Project settings". Click on the "Service Accounts" tab, and then on the blue "Generate new private key" button to create and download a key.
Using Several FCM Service Account Keys
You can provide several service account keys for a single Android app. Batch will automatically use the appropriate key when sending notifications to a token.
This is useful if you have to switch to another Firebase project (e.g. lost Firebase credentials, etc) and want to keep sending push notifications to users who didn't update the app yet. You can also use that feature to avoid creating two separate apps if you don't use the same Firebase project in staging and production.
Click the "Update FCM config" button and confirm. You can now upload a new service account key.
Web push API settings (Chrome, Firefox, Safari on macOS Ventura or higher)
Vapid Keys
Each website has a pair of VAPID keys associated with it:
A public key: Inserted in the JavaScript tag and used to request a subscription to the browser's push service when users turn on push notifications.
A private key: Used by Batch servers to sign the authorization headers sent to the push service of each browser, when you want to send a notification to your opt-in users.
If needed, you can change the VAPID keys to match the one you were using with another provider.
SDK Auth Key
The SDK Auth Key is a key generated by Batch for every website added to the dashboard, using the SDK API Key and the URL declared when you added your website. A new SDK Auth Key will be generated if you change the URL of your website in the dashboard settings.
The Auth Key is used in the JavaScript Tag on your website. It authenticates the requests sent to Batch servers. If that SDK Auth Key doesn't match an existing Auth Key generated in the past for your SDK API Key, Batch will reject the request (e.g. 401 error - unauthorized).
If you need to test your integration on a different domain than the one declared in the dashboard settings, you will need to set the "dev" parameter to true in your JavaScript tag and declare your development origins.
Subdomain Name
Only used in deprecated HTTP / multidomain mode
Name of the subdomain Batch will use for your website.
Safari (≥ macOS Ventura)
For Safari (< macOS Ventura), Batch needs a website name to communicate in the push package requested by Safari before displaying the authorization prompt to a user. This is the name that will appear on your Safari push notifications.
Batch also needs a list of allowed domains as well as push certificates associated with each domain in order to communicate with Apple Push Notification Services (APNS). Each certificate is generated for a unique Website Push ID.
Allowed Dev Origins
List of additional origins authorized in development mode, only when the 'dev' parameter is set to true in your JavaScript tag.
Web Push Icons
Default icon: This icon is displayed on all web push notifications. It is mandatory to upload one for Safari web push configuration.
Small icon: This icon is displayed on web push notifications received on Android devices.
Send rate :
Is counted in messages per minute.
If a Profile has several installations, then messages will always be sent at the same time to all these installations, so there is no risk of a user receiving the same communication but at different times on different installations.
Is common to all platforms (iOS, Android, Web).
Is round down to the lowest integer, e.g. for a rate of 1000 msg/min that's 16.66 msg/s, which we round up to 16msg/s so we can assure that we will never send faster than the specified rate.
Send rate is set in 3 places:
In Channel settings, where it is set as the default value. You can activate it or not, and set a value if activated.
The default send rate will apply to new Orchestrations only, existing Orchestrations will not be impacted by changes to these default settings.
We provide an estimation of the sending time based on the size of the userbase and the defined delivery speed.
In Orchestration settings, where you can change the default value to apply a different send rate to an Orchestration.
Restrictions and limitations:
Minimum and Maximum Send rate :
Minimum: 1,000 messages/minute.
Maximum: 1,000,000 messages/minute.
Maximum Sending Time: when an Orchestration sending time exceed 12 hours, remaining messages are dropped / will not be sent. This prevents excessively long sending durations that could impact Orchestrations effectiveness.
You can set a global expiration delay or a Time To Live (TTL) in hours for all the notifications sent to your app/website users. The notification won't be displayed if the device doesn't receive it or doesn't come back online within this time.
By default, Batch sets a TTL of 14 days for all the notifications you send. If your user's device comes back online before being off for two weeks, it will display the last notification you sent to your user (iOS) or all the notifications sent over the previous two weeks (Android and web push). On iOS, APNS should only store for one month the notification waiting to be displayed.
If you setup a different TTL between iOS and Android and send a push on both platforms, iOS TTL will be leveraged.
Defines the priority of your notifications on iOS (APNS) and Android (FCM). The default value is high on iOS and Android.
On Android, you can use the high priority if you have a messaging/VoIP app and if you notice delivery issues due to native (Doze) or constructor related (Samsung Smart Manager, etc) energy-saving features.
If you setup a different a different priority between iOS and Android and send a push on both platforms, iOS TTL will be leveraged.
Defines how notifications are managed when an offline device goes online. If enabled, the device will only show the most recent notification. If disabled, it will show all the notifications received when the device was offline.
You should disable the collapse key if all your notifications matter (e.g. messages, etc). You can use up to three different collapse keys if you want users to get only one notification of each kind when coming online (e.g. marketing message, alert, etc).
Most SMS settings are configured during implementation. For more information, visit the .
can be toggled on or off anytime in the SMS settings page.
Batch provides a simple tool you can use to see the list of installs tied to a specific ID and the data Batch collected for each one of them. You can search installs based on:
An advertising ID: IDFA (iOS) or GAID (Android). You can find your advertising ID by using My Device ID on iOS or by going to your device settings → Google → Ads on Android.
A Custom User ID: Your own user IDs shared with Batch.
An Installation ID: ID generated by Batch for all the installs the first time your users open the app. You can get your installation ID in the log of your app or display it in your app for debug purposes.
You can also see the data collected for random installs in your userbase.
For every install, the debug tool displays basic information on the left side:
Basic information: Device type, last SDK start date, country, language, installation date, push op-tin status, app/OS/SDK version.
API Key: API key tied to the install. This can be your live or your dev API key.
Custom user ID: Custom User ID set for the install. The field will be empty if no custom user ID is set.
Installation ID: ID generated by Batch for the install when user opened the app for the first time.
Push Token: Push token attached to the install. The field will be empty if Batch hasn't received any token yet for the install or if the token has been invalidated (e.g. uninstall).
On the right side, you will find the list of all the data collected for a specific install:
Native data: app version, bundle ID, carrier code, city code, device brand/type, installation date, last location, and more.
Custom data: You will find here the list of all the attributes, tag collections and events received from the SDK or the Custom Data API. You search a specific value in the list if needed.
The dashboard will display the most recent install first. Simply click again the "Debug" or "Reload" button to refresh the list of installs and update the attributes/events list.
Batch enables you to send a test notification to all the installs attached to the ID you are debugging. Click the "Send Test Push" button at the top of the installs list:
If you need to send push notifications to your device on a regular basis, then you should add your ID as a test device by clicking the "Save as a test device" button.
You can also see if a specific install is or has been in the user journey of a trigger automation. Click the ⚡️ lightning icon in the top right corner of the debug tool. This will show the list of trigger campaigns that targeted your install at some point.
For every campaign, you can see when your install entered the user journey and when/why it exited that user journey:
push_done: Batch sent a push to the install when the timer finished
cancel_event: Your user triggered the cancellation event before the timer finished.
stop: The trigger campaign has been stopped before the timer was finished.
no_pushtoken: Batch tried to send a notification to the install, but it didn't have a token. This may happen if users didn't see the opt-in prompt yet or didn't turn off push notifications on iOS.
pushtokennot_registered: The token attached to the install was not valid anymore when Batch tried to push it. This usually happens when users reinstall or uninstall the app.
query_mismatch: The install was not matching anymore the targeting of the campaign when the timer finished.
There are several points you should check if you don't find any installs matching your advertising ID (IDFA/GAID):
App restriction: Your app may not be able to collect advertising IDs. This happens frequently on iOS, especially if it doesn't displays ads.
Device settings: Check your device settings to be sure you didn't turn on limited ad tracking in Settings → Privacy → Advertising.
Batch integration: Make sure that the advertising id collection hasn't been disabled.
Batch provides a simple debug tool that lets the list of all the targeted push tokens for any given API call to the Transactional API. Go to ⚙️ Settings → Debug, select "Transactional" and input the token generated by the API on each successful call:
The advanced analytics view gives you detailed information for a specific transactional push:
Sent: The total amount of sent push notifications.
Not Found: Number of Custom User ID or installation ID are not linked to any push token.
Undeliverable: Number of push tokens that were flagged as invalid by Apple/Google. Your app may have been uninstalled.
Errors: Number of APNS/FCM/WNS errors.
In the Campaign API for Campaigns sent via API. Check the following documentation to learn more on the .
