ENGAGE® Android SDK Configuration

Before using, the ENGAGE SDK must be configured. The engage-config.json file should be provided by First Orion during the Pre-Integration Steps.

It should be placed directly in the assets folder or an assets sub-folder:

❗️

ENGAGE Config Exception

Only one engage-config.json can be present in the assets folder when the ENGAGE SDK is initialized. If ENGAGE SDK finds multiple conflicting engage-config.json files in the assets folder, then ENGAGE SDK will enter into restricted mode, and all ENGAGE operations and functionality will be disabled. Check if ENGAGE SDK is restricted by executing EngageApp.isEngageRestricted().

app/src/main/assets

The engage-config.json file has the following fields:

{
  "EngageEndpoint": "engage_endpoint_provided_by_first_orion",
  "EngageAppId": "engage_app_id_provided_by_first_orion",
  "EngageTokenType": "token_type_provided_by_first_orion",
  "EngageVerificationType": "verification_type",
  "ConfigVersion": 3.0
}

Config Values

Changeable Fields

The following field are able to be changed by the host app:

ENGAGE Verification Type, Configurable by Host App

This field should indicate how the host app's user will register with the ENGAGE platform. It is able to be configured by the host app. There are 3 main verification types:

• SMS: ENGAGE uses SMS to verify a user's number. User interaction is required. Useful for when host app does not have their own method for verifying users' numbers.
• Pin: ENGAGE platform sends a code to the device via FCM push. This method is rate limited. It auto resolves so no user interaction is required. Useful for when host app has its own method to verify users' numbers.
• Push: ENGAGE platform sends a code to the device via FCM push. This method is not rate limited. It auto resolves so no user interaction is required. Useful for when host app has its own method to verify users' numbers.

Non-Changeable Fields

The following fields are provided by First Orion and may not be changed by the host app:

ENGAGE Endpoint, Provided by First Orion

This endpoint should be provided by First Orion and points to the environment running ENGAGE. This field is not able to be updated by the host app.

ENGAGE App ID, Provided by First Orion

This is a unique ID provided by First Orion that helps the backend identify a specific host app. This field is not able to be updated by the host app.

ENGAGE Token Type, Provided by First Orion

This is the FCM token type that ENGAGE uses to authenticate with the backend and should be provided by First Orion. This field is not able to be updated by the host app.

Config Version, Provided by First Orion

This field is used to tell the ENGAGE backend what config version to use. It is not able to be updated by the host app.