API Reference

A feature-grouped index of every public type the SDK exposes. Each entry links to the page where the type is used in context.

This page is a feature-grouped index of the Zeta Android SDK's public API.

On this page

Client & configuration
User & contacts
Events
Push notifications
In-App Messaging
App Inbox
Logging

Client & configuration

Symbol	Description
`ZetaClient`	Singleton entry point for the SDK.
`ZTConfig`	Configuration object passed to `ZetaClient.initialize()`.
`ZTRegion`	Enum of supported ZMP regions (`US`, `EU`).
`ZTAppEnvironment`	Enum representing the app environment. `PRODUCTION` (default) or `SANDBOX`.

See Getting Started.

User & contacts

Symbol	Description
`ZTUserManager`	Interface exposed via `ZetaClient.user` for user operations.
`ZTUser`	User model built via `ZetaClient.user.builder()...submit()`.
`ZTUserEmail`	Email contact with optional `ZTContactAdditionalInfo`.
`ZTUserPhone`	Phone contact with optional `ZTContactAdditionalInfo`.
`ZTContactAdditionalInfo`	Preferences, subscription status, and custom properties for a contact.
`ZTContactSubscriptionStatus`	Enum of subscription states (`NEW`, `ACTIVE`, `INACTIVE`, `NONE`).

See Contact Management.

Events

Symbol	Description
`ZetaClient.event`	Event tracking namespace.
`trackScreenName()`	Track screen navigation.
`send()`	Send a custom event.

See Contact Management.

Push notifications

Symbol	Description
`ZTPush`	Push notification namespace for configuration and callbacks.
`ZTNotificationConfig`	Notification display configuration (`smallIcon`, `color`, `enableAppLaunch`, `notificationChannel`).
`ZTNotificationChannel`	Notification channel configuration (`id`, `name`, `description`, `showBadge`, `autoCancel`, `notificationSound`).
`ZTNotificationInfo`	Notification payload model. `deepLink` — the campaign's on-tap destination (deep link or web URL). `extra` — a `Map<String, String>` of Additional Values configured in the ZMP campaign builder; use these for custom routing or display logic. `localNotificationId` — the Android notification ID for dismissal via `removeNotification()`.
`ZTPushService`	Firebase Messaging service for receiving push messages.
`getNotificationInfo()`	Retrieve deep link and extra info from a notification intent.
`handleMessage()`	Forward a `RemoteMessage` to the SDK from a custom push service.
`handleMessageMap()`	Forward push data as `Map<String, String>` to the SDK. Accepts an optional `smallIcon` parameter.
`trackEvent()`	Track a notification click event. Accepts `ZTNotificationInfo`.
`removeNotification()`	Dismiss a notification from the status bar by its local ID and optional tag.
`setZtNotificationCallback()`	Callback for Zeta push notifications.
`setNonZtNotificationCallback()`	Callback for non-Zeta push notifications.
`setActionBackgroundCallback()`	Callback for notification action taps while the app is in the background.

See Push Notifications.

In-App Messaging

Symbol	Description
`ZetaClient.inApp`	In-app messaging namespace (`start()` / `stop()`).
`ZTInAppMessage`	The message model passed to lifecycle callbacks.
`ZTInAppMessageLifeCycle`	Interface for `willAppear` / `didAppear` / `onClicked` / `onDismissed`.
`InAppMessageFormData`	Data returned by in-app email collection forms.

See In-App Messaging.

App Inbox

Symbol	Description
`ZTAppInboxManager`	Interface exposed via `ZetaClient.inbox`.
`ZTAppInboxMessage`	A single inbox entry. Key fields: `messageId`, `title`, `body`, `mediaUrl`, `status`, `expirationTimestamp`, `actionList`, `templateId`. `additionalData` — a `Map<String, String>` of Additional Values configured in the ZMP campaign builder; use these for custom routing or display logic in your inbox UI (for example, `{"category": "promo", "variant": "B"}`).
`ZTAppInboxMessageStatus`	Read / unread / deleted state enum.
`ZTCtaAction`	A call-to-action button attached to an inbox message.
`ZTException`	Error type surfaced in App Inbox `onError` callbacks. Contains an error message and optional cause.

Logging

Symbol	Description
`ZTLogger`	Static namespace for all logging APIs.
`ZTLogLevel`	Enum of log severities (`NONE`, `VERBOSE`, `DEBUG`, `INFO`, `WARNING`, `ERROR`).

See Advanced / Logging.

See also

Changelog — complete Added / Changed / Fixed / Removed log for every version.
Migration Guide — breaking changes between versions.