Push

Module: push · Package: com.indigitall.android.push.models · File: Push.kt · Extends: CorePush

Represents a push notification received from the Indigitall platform. Contains all the data needed to display and handle a notification.

{
  "id": {
    "type": "Int",
    "description": "Internal push notification identifier",
    "required": false,
    "default": 0
  },
  "appKey": {
    "type": "String",
    "description": "Application key used to identify the app in the Indigitall platform. Required for the push to be processed.",
    "required": true
  },
  "title": {
    "type": "String",
    "description": "Title of the push notification displayed to the user",
    "required": false
  },
  "body": {
    "type": "String",
    "description": "Main text body of the push notification",
    "required": false
  },
  "icon": {
    "type": "String",
    "description": "URL of the icon image to display in the notification",
    "required": false
  },
  "image": {
    "type": "String",
    "description": "URL of the large image to display in the expanded notification",
    "required": false
  },
  "gif": {
    "type": "ArrayList<String>",
    "description": "List of URLs for GIF frames to display in the notification",
    "required": false
  },
  "layout": {
    "type": "Layout (enum)",
    "description": "Display layout of the notification",
    "required": false,
    "values": ["layout_native", "half_width", "full_width", "custom"],
    "default": "layout_native"
  },
  "data": {
    "type": "String",
    "description": "Custom payload string to pass arbitrary data to the app when the notification is handled",
    "required": false
  },
  "silent": {
    "type": "Boolean",
    "description": "If true, the notification is delivered silently without showing any UI",
    "required": false,
    "default": false
  },
  "securedData": {
    "type": "String",
    "description": "Decrypted secured payload attached to the notification. Populated automatically from securedData/securedKey fields.",
    "required": false
  },
  "isDisposable": {
    "type": "Boolean",
    "description": "If true, the notification will be dismissed after being displayed",
    "required": false,
    "default": true
  },
  "sendingId": {
    "type": "String",
    "description": "Identifier of the sending campaign instance",
    "required": false
  },
  "campaignId": {
    "type": "String",
    "description": "Identifier of the campaign this push belongs to",
    "required": false
  },
  "pushId": {
    "type": "Int",
    "description": "Identifier of the push template",
    "required": false,
    "default": 0
  },
  "journeyStateId": {
    "type": "Int",
    "description": "Identifier of the journey state associated with this push",
    "required": false,
    "default": 0
  },
  "journeyExecution": {
    "type": "Int",
    "description": "Journey execution counter",
    "required": false,
    "default": 0
  },
  "cjCurrentStateId": {
    "type": "Int",
    "description": "Current state ID in the customer journey",
    "required": false,
    "default": 0
  },
  "sendEventAck": {
    "type": "Boolean",
    "description": "If true, an acknowledgement event should be sent back to the server upon reception",
    "required": false,
    "default": false
  },
  "applicationId": {
    "type": "Int",
    "description": "Indigitall application identifier",
    "required": false
  },
  "action": {
    "type": "PushAction",
    "description": "Action to execute when the user taps the notification. See PushAction model.",
    "required": false
  },
  "buttons": {
    "type": "ArrayList<PushButton>",
    "description": "List of action buttons displayed in the expanded notification. See PushButton model.",
    "required": false
  }
}

PushAction

Extends: CoreAction

Defines the action executed when a push notification (or button) is tapped.

{
  "type": {
    "type": "Type (enum)",
    "description": "Type of action to perform",
    "values": ["app", "url", "webview", "call", "market", "share", "no_action", "wallet"]
  },
  "url": {
    "type": "String",
    "description": "URL to open when type is 'url' or 'webview'"
  },
  "app": {
    "type": "String",
    "description": "Deep-link or activity class name to open when type is 'app'"
  },
  "call": {
    "type": "String",
    "description": "Phone number to dial when type is 'call'"
  },
  "market": {
    "type": "String",
    "description": "Market URL or package name to open when type is 'market'"
  },
  "share": {
    "type": "String",
    "description": "Text content to share when type is 'share'"
  },
  "wallet": {
    "type": "String",
    "description": "Wallet pass URL when type is 'wallet'"
  },
  "topics": {
    "type": "Array<String>",
    "description": "Topic codes to subscribe/unsubscribe when the action is executed"
  },
  "clickedButton": {
    "type": "Int",
    "description": "Index of the button clicked (-1 if the notification body was tapped)",
    "default": -1
  }
}

PushButton

Extends: CorePushButton

Represents an action button displayed in an expanded push notification.

{
  "label": {
    "type": "String",
    "description": "Text label displayed on the button"
  },
  "action": {
    "type": "PushAction",
    "description": "Action to execute when the button is tapped. See PushAction model."
  },
  "topics": {
    "type": "Array<String>",
    "description": "Topic codes associated with the button action"
  }
}

Device

Module: push · Package: com.indigitall.android.push.models · File: Device.kt · Extends: CoreDevice

Represents the Android device registered in the Indigitall platform. Contains hardware, OS, app and push token information used for device registration and targeting.

{
  "deviceId": {
    "type": "String",
    "description": "Unique device identifier assigned by Indigitall",
    "required": false
  },
  "pushToken": {
    "type": "String",
    "description": "Firebase Cloud Messaging (FCM) token used to send push notifications to this device",
    "required": false
  },
  "enabled": {
    "type": "Boolean",
    "description": "Whether the device has push notifications enabled",
    "required": false,
    "default": false
  },
  "platform": {
    "type": "String",
    "description": "Platform identifier",
    "required": false,
    "values": ["android", "harmony"]
  },
  "version": {
    "type": "String",
    "description": "Indigitall SDK version name",
    "required": false
  },
  "productName": {
    "type": "String",
    "description": "Name of the product/app as configured in Indigitall",
    "required": false
  },
  "productVersion": {
    "type": "String",
    "description": "Version of the product/app as configured in Indigitall",
    "required": false
  },
  "osName": {
    "type": "String",
    "description": "Operating system name. Always 'Android'.",
    "required": false,
    "example": "Android"
  },
  "osVersion": {
    "type": "String",
    "description": "Android OS version including SDK level",
    "required": false,
    "example": "13 (SDK:33)"
  },
  "deviceBrand": {
    "type": "String",
    "description": "Device manufacturer brand in uppercase",
    "required": false,
    "example": "SAMSUNG"
  },
  "deviceModel": {
    "type": "String",
    "description": "Device model name in uppercase",
    "required": false,
    "example": "SM-G991B"
  },
  "operator": {
    "type": "String",
    "description": "Mobile network operator name. 'unknown' if unavailable.",
    "required": false,
    "default": "unknown"
  },
  "deviceType": {
    "type": "String",
    "description": "Form factor of the device",
    "required": false,
    "values": ["mobile", "tablet"]
  },
  "appVersion": {
    "type": "String",
    "description": "Version name of the host application",
    "required": false
  },
  "locale": {
    "type": "String",
    "description": "Device locale string",
    "required": false,
    "example": "es_ES"
  },
  "timeZone": {
    "type": "String",
    "description": "Device time zone ID",
    "required": false,
    "example": "Europe/Madrid"
  },
  "timeOffset": {
    "type": "Int",
    "description": "UTC offset of the device time zone in minutes",
    "required": false
  },
  "externalCode": {
    "type": "String",
    "description": "HMAC-SHA256 hashed external user identifier used to link the device to a user in external systems",
    "required": false
  },
  "externalApps": {
    "type": "Array<ExternalApp>",
    "description": "List of external apps linked to this device. See ExternalApp model.",
    "required": false
  }
}

ExternalApp

Represents an external application associated with the device.

{
  "id": {
    "type": "Int",
    "description": "Unique identifier of the external application"
  },
  "name": {
    "type": "String",
    "description": "Display name of the external application"
  },
  "androidCode": {
    "type": "String",
    "description": "Android package name or code of the external application"
  }
}

DeviceStatus

Integer annotation defining the device enabled/disabled status.

{
  "STATUS_DEFAULT": { "value": -1, "description": "No status change requested" },
  "STATUS_ENABLE":  { "value": 1,  "description": "Device notifications enabled" },
  "STATUS_DISABLE": { "value": 0,  "description": "Device notifications disabled" }
}

Customer

Module: customer · Package: com.indigitall.android.customer.models · File: Customer.kt

Represents a customer/user profile registered in the Indigitall platform. Used to link a device to a specific user identity.

{
  "id": {
    "type": "String",
    "description": "Internal Indigitall identifier for the customer record",
    "required": false
  },
  "customerId": {
    "type": "String",
    "description": "External user identifier provided by the host application (e.g. user ID from your backend). Loaded from stored preferences.",
    "required": false
  },
  "applicationId": {
    "type": "String",
    "description": "Indigitall application identifier associated with this customer",
    "required": false
  },
  "createdAt": {
    "type": "String",
    "description": "ISO 8601 timestamp of when the customer record was created",
    "required": false
  },
  "updatedAt": {
    "type": "String",
    "description": "ISO 8601 timestamp of the last update to the customer record",
    "required": false
  }
}

CustomerField

Represents a single custom attribute key-value pair for a customer profile.

{
  "customerFieldKey": {
    "type": "String",
    "description": "Name/key of the custom attribute"
  },
  "customerFieldValue": {
    "type": "String",
    "description": "Value of the custom attribute"
  }
}

InboxNotification

Module: inbox · Package: com.indigitall.android.inbox.models · File: InboxNotification.kt

Represents a single notification entry stored in the user's inbox. Contains the notification content, metadata, category and read status.

{
  "id": {
    "type": "String",
    "description": "Unique identifier of the inbox notification entry",
    "required": false,
    "default": ""
  },
  "externalId": {
    "type": "String",
    "description": "External identifier of the notification",
    "required": false,
    "default": ""
  },
  "sentAt": {
    "type": "String",
    "description": "ISO 8601 timestamp of when the notification was sent",
    "required": false
  },
  "status": {
    "type": "String",
    "description": "Current interaction status of the notification",
    "required": false,
    "values": ["sent", "click", "deleted"]
  },
  "sendingId": {
    "type": "Int",
    "description": "Identifier of the sending instance",
    "required": false,
    "default": 0
  },
  "campaignId": {
    "type": "Int",
    "description": "Identifier of the campaign this notification belongs to",
    "required": false,
    "default": 0
  },
  "message": {
    "type": "InboxPush",
    "description": "Push notification content associated with this inbox entry. See InboxPush model.",
    "required": false
  },
  "category": {
    "type": "InboxCategory",
    "description": "Category this notification belongs to. See InboxCategory model.",
    "required": false
  },
  "read": {
    "type": "Boolean",
    "description": "True if the notification was sent before the user's last inbox access (considered read)",
    "required": false,
    "default": false
  }
}

InboxPush

Extends: CorePush

Push notification content stored in the inbox. Inherits all fields from CorePush (id, appKey, title, body, icon, image, gif, layout, data, silent, securedData, isDisposable, sendingId, campaignId, pushId, journeyStateId, journeyExecution, cjCurrentStateId, sendEventAck, applicationId) plus the inbox-specific fields below.

{
  "action": {
    "type": "InboxPushAction",
    "description": "Action to execute when the notification is tapped (same structure as PushAction)"
  },
  "buttons": {
    "type": "ArrayList<InboxPushButton>",
    "description": "Action buttons for the inbox notification entry (same structure as PushButton)"
  }
}

InboxCategory

Category used to group and filter inbox notifications.

{
  "id": {
    "type": "Int",
    "description": "Unique identifier of the category"
  },
  "code": {
    "type": "String",
    "description": "Alphanumeric code of the category"
  },
  "name": {
    "type": "String",
    "description": "Display name of the category"
  }
}

InboxStatus

Enum representing the interaction status of an inbox notification.

{
  "SENT":    { "value": "sent",    "description": "Notification was sent but not yet interacted with" },
  "CLICK":   { "value": "click",   "description": "Notification was clicked/opened by the user" },
  "DELETED": { "value": "deleted", "description": "Notification was deleted by the user" }
}

InApp

Module: inapp · Package: com.indigitall.android.inapp.models · File: InApp.java

Represents an in-app message served by the Indigitall platform. Contains display configuration, filtering rules, schema layout and custom data.

{
  "inAppId": {
    "type": "Int",
    "description": "Unique identifier of the in-app message",
    "required": false,
    "default": 0
  },
  "lastVersionId": {
    "type": "Int",
    "description": "Identifier of the last active version of this in-app message",
    "required": false,
    "default": 0
  },
  "version": {
    "type": "Int",
    "description": "Version number of the in-app message content",
    "required": false,
    "default": 0
  },
  "inAppVersion": {
    "type": "Int",
    "description": "Version of the in-app message (falls back to 'version' if not explicitly set)",
    "required": false,
    "default": 0
  },
  "name": {
    "type": "String",
    "description": "Display name or identifier of the in-app message",
    "required": false,
    "default": ""
  },
  "showOnce": {
    "type": "Boolean",
    "description": "Deprecated. If true, the message is shown only once per user. Use InAppShow configuration instead.",
    "required": false,
    "default": false,
    "deprecated": true
  },
  "creationDate": {
    "type": "String",
    "description": "ISO 8601 timestamp of when the in-app message was created",
    "required": false
  },
  "expiredDate": {
    "type": "String",
    "description": "ISO 8601 timestamp of when the in-app message expires and should no longer be shown",
    "required": false
  },
  "cacheTtl": {
    "type": "String",
    "description": "Time-to-live for caching the in-app content on the device",
    "required": false
  },
  "silent": {
    "type": "Boolean",
    "description": "If true, the in-app is processed silently without displaying any UI",
    "required": false,
    "default": false
  },
  "profile": {
    "type": "String",
    "description": "User profile segment identifier associated with this in-app message",
    "required": false
  },
  "properties": {
    "type": "InAppProperties",
    "description": "Visual and behavioral properties of the in-app message (colors, position, size, etc.)",
    "required": false
  },
  "schema": {
    "type": "InAppSchema",
    "description": "Layout schema definition of the in-app message content",
    "required": false
  },
  "inAppShow": {
    "type": "InAppShow",
    "description": "Configuration controlling when and how often the in-app message is displayed",
    "required": false
  },
  "filters": {
    "type": "InAppFilters",
    "description": "Targeting filters determining which users or sessions should see this in-app message",
    "required": false
  },
  "customData": {
    "type": "HashMap<String, String>",
    "description": "Free-form key-value map with custom data attached to the in-app message. Also includes the 'version' key.",
    "required": false
  }
}

LiveActivity

Module: liveactivity · Package: com.indigitall.android.liveactivity.models · File: LiveActivity.kt

Represents a Live Activity session registered in the Indigitall platform. On Android, Live Activities are implemented via dynamic FCM topics to enable real-time push updates.

{
  "liveActivityId": {
    "type": "String",
    "description": "Unique identifier of the Live Activity record in Indigitall",
    "required": false
  },
  "liveActivityExternalId": {
    "type": "String",
    "description": "External identifier provided by the host application to identify the Live Activity session",
    "required": false
  },
  "applicationId": {
    "type": "Int",
    "description": "Indigitall application identifier this Live Activity belongs to",
    "required": false
  },
  "androidTopicId": {
    "type": "String",
    "description": "FCM topic ID used to deliver real-time updates to this Live Activity on Android",
    "required": false
  },
  "status": {
    "type": "String",
    "description": "Current status of the Live Activity session (e.g. active, ended)",
    "required": false
  },
  "createdAt": {
    "type": "String",
    "description": "ISO 8601 timestamp of when the Live Activity was registered",
    "required": false
  },
  "updatedAt": {
    "type": "String",
    "description": "ISO 8601 timestamp of the last update to the Live Activity record",
    "required": false
  }
}

Topic

Module: push · Package: com.indigitall.android.push.models · File: Topic.java · Extends: CoreTopic

Represents a push notification topic (category) that a device can subscribe to or unsubscribe from. Used to segment users by areas of interest.

{
  "code": {
    "type": "String",
    "description": "Unique alphanumeric code identifying the topic",
    "required": true
  },
  "name": {
    "type": "String",
    "description": "Human-readable display name of the topic",
    "required": false
  },
  "visible": {
    "type": "Boolean",
    "description": "If true, the topic is shown in the topic preference UI to the user",
    "required": false,
    "default": false
  },
  "subscribed": {
    "type": "Boolean",
    "description": "Whether the current device is subscribed to this topic",
    "required": false,
    "default": false
  },
  "parentCode": {
    "type": "String",
    "description": "Code of the parent topic, used to build hierarchical topic trees",
    "required": false
  },
  "channel": {
    "type": "Channel (enum)",
    "description": "Channel this topic belongs to. Always PUSH for push module topics.",
    "required": false,
    "values": ["PUSH"],
    "default": "PUSH"
  }
}