iOS Activation Customisation

For a quick primer on the activation steps please check:

First create a file called KBActivation.json in the KBCustomization folder in the root folder of your app. The KBActivation.json file customises the Onboarding experience.

Then paste the following contents and begin customisation

{
  "ac1_activation_bg_color": "#ffffff",
  "ac2_activation_text_color": "#333333",
  "ac3_splash_bg_color": "#DB0019",
  "ac4_splash_text_color": "#D9D9D9",
  "ac5_activation_secondary_color": "#009379",
  "ac6_main_color_foreground_color": "#ffffff",
  "ac7_main_color": "#DB0019",
  "ob_success_header_logo_image": "ob_success_header_logo_image",
  "slides": [
    {
      "order": 0,
      "title": "Onboarding Slide 1 title",
      "description": "Onboarding Slide 1 subtitle",
      "asset": "ac_1_image"
    },
    {
      "order": 1,
      "title": "Onboarding Slide 2 title",
      "description": "Onboarding Slide 2 subtitle",
      "asset": "ac_2_image"
    },
    {
      "order": 2,
      "title": "Onboarding Slide 3 title",
      "description": "Onboarding Slide 3 subtitle",
      "asset": "ac_3_image"
    },
    {
      "order": 3,
      "title": "Onboarding Slide 4 title",
      "description": "Onboarding Slide 4 subtitle",
      "asset": "ac_4_image"
    }
  ]
}

ac1_activation_bg_color, ac2_activation_text_color - activation background and text colors for all activation screens
ac3_splash_bg_color, ac4_splash_text_color - background and text colours for the Splash screen
ac5_activation_secondary_color, ac6_main_color_foreground_color, ac7_main_color - main and secondary colours of the partener brand, in the context of the activation screens
slides array - customises the Selling Benefits screens:
- slides.count - number of screens
- order - the Selling Benefits screens are presented in UI flow in the ascending order for this field
- title - strings file key for the title field. In the UI we get the localised version. The string with this key exists (and needs to exist) in the strings file.
- description - strings file key for the description field. In the UI we get the localised version. The string with this key exists (and needs to exist) in the strings file.
- asset - the name of the UI asset that exists in Media.assets and contains the picture in the screen. See
  Assets

Deep Linking to the Main App at the End of Onboarding

In addition to the customizable onboarding slides, the Cashback Keyboard SDK now supports an optional feature that allows users to be redirected to a specific screen within the main application immediately after completing the onboarding process. This is accomplished by specifying a deep link URL in the KBActivation.json file.

deeplinkUrl Key
To utilize this feature, add a deeplinkUrl key at the same level as the slides array in your KBActivation.json configuration file. The deeplinkUrl should contain a URL that is handled by your main app to navigate the user to the desired screen.

Example Configuration with deeplinkUrl:

{
  "slides": [],
  "deeplinkUrl": "yourapp://main_screen"
}

Behavior

When deeplinkUrl is defined: Upon tapping the button at the end of the onboarding process, the SDK attempts to open the specified URL. This requires that the main app is configured to handle the provided URL scheme and path, ensuring that the user is navigated to the appropriate screen.

When deeplinkUrl is missing: The default behavior is preserved; the application will minimize/close when the user completes the onboarding process.

Configuring Your Main App to Handle Deep Links
To ensure a seamless experience, your main application must be configured to recognize and handle the deep link URL specified in the KBActivation.json file. This typically involves registering the URL scheme within your app and implementing the necessary logic to navigate to the specified screen when the app is opened via a deep link.