All pages
Powered by GitBook
1 of 1

Loading...

Developer Portal

Welcome to Batch's developer portal!

Here, you’ll find everything you need to integrate with Batch—whether you’re working on the client side using our SDKs, or on the server side with our APIs.

Our resources include high-level usage guides, sample code, and detailed API references to help you get started quickly.

Customer Engagement Platform APIs

Batch’s Customer Engagement Platform APIs give you server-side access to our new, profile-oriented data model—making it easy to manage and act on user data at scale.

SDKs

Batch's SDKs bring our features to your app in a developer-friendly API.

What is an SDK?

"SDK" stands for Software Development Kit.

An SDK is a set of tools developers can use to create apps for a specific platform or to add features to their apps without having to redevelop them from scratch. Apps usually integrate a wide variety of third-party analytics and marketing SDKs.

Here is a non-exhaustive list of the purposes the SDK serves:

  • Analytics: registers new installs, sends app usage data and feedback on push and In-App interactions (e.g. push displayed, opened, In-App message dismissed, etc).

  • Data collection: collects and sends Profile data (attributes, events) to Batch servers to improve your segmentation and personalization.

  • Push notifications: collects and sends the push token to Batch servers, required to deliver a push to your users' devices. On Android, the receiver included in the SDK is in charge of receiving and displaying the notifications.

  • In-App messaging: pulls the list of In-app campaigns matching your users' install from Batch servers and displays the In-app messages.

Available SDKs and Plugins

SDK Downloads

Most SDKs and Plugins are not to be downloaded directly but integrated by using a package manager: the ones Batch support and how to use the SDK with them is detailed in the "SDK Integration" pages.

You can also find us on where you will find our SDKs & Plugins source code and sample apps you can use to test our features with.

Mobile Engagement Platform APIs

  • Inbox: Provides the history of push notifications sent to the install or the user ID attached to the install. This is useful if you want to add a notification centre to your app.

  • API Changelog
    GitHub
    Cover

    Profiles

    Update or export profile attributes & events

    Cover

    Audiences

    Manage and populate audiences

    Cover

    Campaigns

    Create omnichannel campaigns

    Cover

    Exports

    Manage requested exports

    iOS

    Android

    Web

    Flutter

    React Native

    Cordova

    Transactional

    Campaigns

    In-app Campaigns

    Custom Audience

    Custom Data

    App Data

    GDPR

    Export

    Webhooks

    Trigger Events