Channels
You will find here all the settings related to your different channels.
Email Settings
Email senders
Email settings is where you setup email senders, such as "[email protected]".
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.
Send rate
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 Push Send rate documentation a bit further down this page.
Push Settings
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 'delivery speed,' and Push V2, where it's named 'send rate.
To learn more about Push V1 settings, check this documentation.
Push configuration
Apple Push Notification Service (APNS)
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 Developer Console.
Team ID: The team ID is also available from the Developer Console.
Firebase Cloud Messaging (FCM)
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 Firebase Console.
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
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.
Orchestration default settings
Send rate
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.
In the Campaign API for Campaigns sent via API. Check the following documentation to learn more on the Campaign API.
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.
Expiration (TTL)
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.
Priority
iOS/Android only
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.
Collapse Key
Android only
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).
SMS Settings
SMS settings are all managed at implementation time. For more details about SMS, see SMS Channel page.
Last updated
Was this helpful?