For the complete documentation index, see llms.txt. This page is also available as Markdown.

Core Concepts

Core vocabulary for every Digia Engage integration: experience types, the keys that link a CEP campaign to a Digia design, the app-side components, and which experiences each CEP supports.

Every integration guide — CleverTap, MoEngage, WebEngage — assumes the vocabulary on this page. Read it once and the per-CEP guides become mostly glue code.

The model in one line: your CEP decides who sees an experience and when; Digia decides what renders. See How It Works for the full runtime flow.


Experience Types

Digia Engage renders four experience types, and all three supported CEPs — CleverTap, MoEngage, and WebEngage — can deliver every one. Each is backed by a different app-side component and may need a one-time developer step before product and marketing can use it freely.

Experience
Digia component
What it is
One-time developer step

Nudge

DigiaHost

Overlay above all app content — bottom sheet or dialog. Promotions, announcements, rating prompts.

Mount the host once.

Guide

DigiaAnchor + DigiaHost

Tooltip or spotlight anchored to a UI element. Onboarding tours, feature discovery.

Wrap each targetable element in DigiaAnchor.

Inline

DigiaSlot

Content injected into your own layout — banners, cards, strips inside a feed.

Place a DigiaSlot at each spot content can appear.

Survey

DigiaHost

Multi-step questionnaire rendered as an overlay (NPS, feedback). Delivered exactly like a Nudge.

Mount the host once (same as Nudge).

Once the one-time step is in place, an experience's type, design, and content are all controlled from the Digia dashboard — no further code and no app release.


Identifiers

Three identifiers connect a CEP campaign, a Digia design, and your app. Every one is case-sensitive and must match exactly on both sides, or nothing renders.

Identifier
What it points to
Set where
Must match

digia_campaign_key

A whole Digia campaign (it carries its own type and design)

Copied from the Digia dashboard → set in your CEP campaign (CleverTap, MoEngage, or WebEngage)

The campaign key in the Digia dashboard

placementKey

An inline slot in your app

App code (DigiaSlot / DigiaSlotView) ↔ the inline campaign in Digia

The slot key on the inline campaign

anchorKey

A UI element a guide step points to

App code (DigiaAnchor / DigiaAnchorView) ↔ the guide step in Digia

The anchor key on the guide step

Every CEP links with the same field — digia_campaign_key. The campaign it points to already carries its own type and design. See How linking works below.


App-side Components

Component
Role
Notes

DigiaHost

The overlay host that renders Nudges, Guides, and Surveys above your app.

Mount once at the app root.

DigiaHostView

The View-system (Android XML) wrapper around DigiaHost.

Use in non-Compose Android; some React Native setups also mount it — follow the per-CEP guide.

DigiaSlot / DigiaSlotView

Renders inline content at a named placementKey. Collapses to zero height when no campaign is active.

DigiaSlotView is the View-system / React Native variant.

DigiaAnchor / DigiaAnchorView

Marks a UI element as a guide target via anchorKey.

…View is the View-system variant.

Host wiring varies by CEP and platform. Which host component(s) you mount — and whether one attaches automatically — differs across CleverTap, MoEngage, and WebEngage. Always follow the Setting Up Nudges section of the specific integration guide rather than assuming.


How Linking Works

Every CEP links to Digia with the same field — digia_campaign_key. Only where you set it differs:

  • CleverTap — in the DigiaTemplate custom-code In-App template (Inline uses Native Display). → CleverTap guide

  • MoEngage — in the Self-Handled In-App campaign's Key-Value Pairs. → MoEngage guide

  • WebEngage — in the In-App (Custom HTML) campaign's digia-config block. → WebEngage guide

For what happens when a user taps a button or card inside any experience, see Campaign Actions.

Last updated