• Dashboard
  • API
  • Guides
  • Third Party Integrations
  • FAQ
  • Android > Advanced

    Custom actions

    Batch Actions is a module allowing you to register remotely-configurable runnable code to the SDK, when simple deeplinks wouldn't be enough. They can be triggered at any time by the SDK, allowing you to focus on the action code rather than when to trigger it.

    Batch comes with builtin actions (deeplinking, user data edition, etc...)

    Registering an action

    An action has two components:

    • An identifier (case-unsensitive string), which will allow you to reference this action
      • While the identifier string is up to you, it cannot start with "batch.": these identifiers are reserved for built-in actions.
    • An implementation class

    Registering them is easy, and should be done in your Application subclass, right before starting Batch:

    Batch.Actions.register(new UserAction("<YOUR_ACTION_NAME>", new UserActionRunnable() {
        public void performAction(@Nullable Context context, @NonNull String identifier, @NonNull JSONObject args, @Nullable UserActionSource source) {
            // Your action code here

    The source argument represents what caused the action to be triggered. You can use instanceof to check what source it comes from, and read what you need.
    Two sources classes are currently used: BatchLandingMessage and PushUserActionSource. More will be added in the future.

    Unregistering an action

    Simply call the unregister method with the previously set identifier:


    Triggering an action

    You might want to re-use the code you've already registered to Batch from your own code by triggering an action.

    Simply give Batch the action identifier and arguments, and it will call your action:

    try {
        final JSONObject args = new JSONObject();
        args.put("title", "Hello");
        args.put("body", "How are you doing?");
        Batch.Actions.performAction(this, "alert", args);
    } catch (JSONException e) {

    Note: Built-in Batch actions are reserved to the SDK and not triggerable that way