Get Started

Before you can take advantage of our SDK, you need to install the module(s) you want to use, initialize the SDK, and understand the order of operations.

This page is part of an introductory series to help you get started with the essential features of our SDK. The highlighted step(s) below are covered on this page. Before you continue, make sure you've implemented previous features—i.e. you can't identify people before you initialize the SDK!

graph LR getting-started(Install SDK) -->B(Initialize SDK) B --> identify(identify people) identify -.-> track-events(Send events) identify -.-> push(Receive push) identify -.-> rich-push(Receive Rich Push) track-events --> test-support(Handle errors) push --> test-support rich-push --> test-support click getting-started href "/docs/sdk/android/getting-started" click B href "/docs/sdk/android/getting-started/#initialize-the-sdk" click identify href "/docs/sdk/android/identify" click track-events href "/docs/sdk/android/track-events/" click push href "/docs/sdk/android/push" click rich-push href "/docs/sdk/android/rich-push" click test-support href "/docs/sdk/android/test-support" style getting-started fill:#B5FFEF,stroke:#007069 style B fill:#B5FFEF,stroke:#007069

How it works

Our SDKs provide a ready-made integration to identify people who use mobile devices and send them notifications. Before you start using the SDK, you should understand a bit about how the SDK works with customer.io.

sequenceDiagram participant A as Mobile User participant B as SDK participant C as Customer.io A--xB: User activity
user not identified A->>B: Logs in (identify method) rect rgb(229, 254, 249) Note over A,C: Now you can Send events and receive messages B-->>C: Person added/updated in CIO A->>B: User activity (track event) B->>C: Event triggers campaign C->>B: Campaign triggered push B->>A: Display push A->>B: Logs out (stopIdentify method) end A--xB: No longer sending events or receiving messages

You must identify a person before you can take advantage of most SDK features. We don’t currently support messages or events for anonymous devices/users, which means that we can’t track or respond to anything your audience does in your app until you identify them.

In Customer.io, you identify people by id or email, which typically means that you need someone to log in to your app or service before you can identify them.

While someone is “identified”, you can send events representing their activity in your app to Customer.io. You can also send the identified person messages from Customer.io.

You send messages to a person through the Customer.io campaign builder, broadcasts, etc. These messages are not stored on the device side. If you want send an event-triggered campaign to a mobile device, the mobile device user must be identified and have a connection such that it can send an event back to Customer.io and receive a message payload.

SDK packages

To minimize our impact on your app’s size, we offer multiple, separate SDKs. You should only install the SDKs that you need for your project.

You must install the Tracking SDK. It lets you identify people, which you must do before you can send them messages, track their events, etc.

PackageRequired?Description
trackingidentify people in Customer.io
messaging-push-fcmReceive and interpret push notifications

Install the SDK

You’ll find detailed instructions to install our SDK in our Github repository.

  1. Before you add Customer.io dependencies, update your repositories in the settings.gradle file to include mavenCentral():

    dependencyResolutionManagement {
       repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
       repositories {
          google()
          mavenCentral()
       }
    }
       

    Or, if you’re using an earlier project setup, make sure that you have added mavenCentral() as a repository in your root-level build.gradle file:

    allprojects {
       repositories {
          google()        
          mavenCentral()
       }
    }
       
  2. Install the dependencies that are relevant to your implementation. Replace version-here with the the latest version (available in our github repository).

    implementation 'io.customer.android:tracking:<version-here>'
    implementation 'io.customer.android:messaging-push-fcm:<version-here>'
       

Initialize the SDK

Before you can use the Customer.io SDK, you need to initialize it. CustomerIO is a singleton: you’ll create it once and re-use it across your application.

You should initialize CustomerIO in the Application class, so that you can access that instance from any part of your application using the instance() method.

class App : Application() {
   override fun onCreate() {
      super.onCreate()
      val customerIO = CustomerIO.Builder(
         siteId = "your-site-id",
         apiKey = "your-api-key",
         appContext = this
      ).build()
   }
}

The Builder for CustomerIO exposes configuration options for features like region, and timeout.

val builder = CustomerIO.Builder(
   siteId = "YOUR-SITE-ID",
   apiKey = "YOUR-API-KEY",
   appContext = this
)
builder.setRegion(Region.EU)
// set the request timeout for all the API requests sent from SDK
builder.setRequestTimeout(8000L)
builder.build()

 Check out our sample app!

Our Remote Habits app, provides a real-world example and can act as a template to help you implement the SDK.

The Processing Queue

The SDK automatically adds all calls to a queue system, and performs these calls when certain criteria is met. This queue makes things easier, both for you and your users: it handles errors and retries for you (even when users lose connectivity), and it saves users' battery life by batching requests.

The queue holds requests until any one of the following criteria is met:

  • There are 10 or more tasks in the queue.
  • 30 seconds have passed since the SDK performed its last task.
  • The app is closed and re-opened.

For example, when you identify a new person in your app using the SDK, you won’t see the created/updated person immediately. You’ll have to wait for the SDK to meet any of the criteria above before the SDK sends a request to the Customer.io API. Then, if the request is successful, you’ll see your created/updated person in your workspace.

How the queue organizes tasks

The SDK typically runs tasks in the order that they were called—unless one of the tasks in the queue fails.

Tasks in the queue are grouped by “type” because some tasks need to run sequentially. For example, you can’t invoke a track call if an identify call hasn’t succeeded first. So, if a task fails, the SDK chooses the next task in the queue depending on whether or not the failed task is the first task in a group.

  • If the failed task is the first in a group: the SDK skips the remaining tasks in the group, and moves to the next task outside the group.
  • If the failed task is 1+n task in a group: the SDK skips the failed task and moves on to the next task in the group.**

The following chart shows how the SDK would process a queue where tasks A, B, and C belong to the same group.

flowchart TD a["Task inventory
[A, B, C], D"]-->b{Is task A
successful} b-.->|Yes|c[Continue to task B] b-.->|No|d[Skip to task D] c-.->|Whether task B
succeeds or fails|E[Continue to task C]
Copied to clipboard!