Documentation
Everything you need to run EngageApp — build campaigns, connect channels, grow your audience, measure results, and integrate with the SDKs and public API.
New to EngageApp?
Start with the concepts, then send your first campaign end-to-end in about ten minutes.
Getting Started
- Getting started Learn how EngageApp works — contacts, channels, templates, and campaigns — and how to authenticate with API keys.
- Send your first campaign A ten-minute walkthrough that takes you from an empty workspace to a live campaign delivering messages to your contacts.
- Key concepts A glossary of the core objects in EngageApp — contacts, channels, templates, campaigns, segments, events, and more.
- Onboarding checklist The guided Get started checklist tracks your setup progress in real time and shows what each step unlocks.
Campaigns
- Campaigns overview A campaign is a visual, multi-step flow that enrolls contacts and sends them messages across channels.
- Flow builder The drag-and-drop canvas where you assemble a campaign from trigger, send, delay, condition, and wait-until steps.
- Triggers & enrollment A trigger decides how contacts get enrolled into a campaign — manually, by event, on a schedule, or when they join or leave a segment.
- A/B testing Add weighted message variants to a send step to test different templates and compare their performance in analytics.
- Conversion goals & topic gating Define the event that counts as success for a campaign, and gate its sends to contacts subscribed to a topic.
- AI campaign generation Describe a goal in plain language and get a complete multi-step campaign — copy, timing, channels, and steps.
- Campaign gallery A library of pre-built campaign blueprints you can preview and clone into an editable draft.
Audience
- Contacts How EngageApp models your end-users as contacts, the fields they carry, and the ways to add them.
- Importing contacts Bulk-load or update your audience by uploading a CSV and mapping its columns to contact fields.
- Segments Group contacts by attribute and behavior rules to target campaigns and manual enrollments.
- Events Send behavioral events about your contacts to trigger campaigns, gate waits, and power segments.
Content
- Templates Author reusable message content for each channel, with per-contact merge fields resolved at send time.
- Email editor Compose responsive email visually with block-based, MJML-powered templates.
- Push templates Define the title, body, click action, and custom data for push notifications.
- Assets Upload images to a CDN-backed media library and reuse their URLs across templates.
- Topics & preferences Offer subscription categories so contacts give granular, compliant consent instead of an all-or-nothing unsubscribe.
Channels
- Channels overview The delivery channels EngageApp supports — email, SMS, WhatsApp, push, custom API, and full-screen in-app takeovers.
- Email channel Send provider-backed email through SMTP or a hosted provider, authored with the visual MJML editor.
- SMS channel Send text messages through Twilio, Termii, BulkSMS, 5LinkxSMS, or Vonage — self-hosted or platform-managed.
- WhatsApp channel Send WhatsApp messages through the official Meta Cloud API or a self-hosted GOWA connection.
- Push channel Send mobile push notifications through Firebase Cloud Messaging to a contact's registered devices.
- Custom API channel Deliver a rendered message to any HTTP endpoint you control to reach channels EngageApp doesn't support natively.
- In-App Takeover setup Integrate the EngageApp SDK (Web or Flutter) so full-screen in-app takeover campaigns render natively when your users open your app.
Deliverability
Engagement Autopilot
- Engagement Autopilot An AI engagement brain that watches each contact’s lifecycle, spots opportunities, and proactively drafts (or ships) tailored campaigns to grow retention.
- Activating the autopilot Turn on the Engagement Autopilot: pick a lifecycle model, map your events to canonical behaviors, choose autonomy, and select participating channels.
- Lifecycle classification How the autopilot places every contact on a lifecycle stage from their behavior, and the six predefined business models it can use.
- Opportunities & the review queue The micro-segments the autopilot detects, how it drafts a campaign for each, and how you approve or dismiss them.
- Autonomy & guardrails Choose whether the autopilot proposes or ships campaigns, and set the volume, audience, and channel limits that bound it.
- Performance & the learning loop Measure the lift from autopilot-generated campaigns, and see how results feed back into future generation.
- Real-time detection How high-intent events trigger opportunity detection in near-real time, in addition to the periodic sweep.
- Integration guide Everything you instrument on your side to power the Engagement Autopilot — contacts, events, the canonical behaviors, channels, and verification.
- Example: SaaS (Slack) A complete autopilot integration for a team-collaboration SaaS like Slack — events, mapping, stages, and campaigns.
- Example: E-commerce (Konga) A complete autopilot integration for an online retailer like Konga — events, mapping, stages, and campaigns.
- Example: Marketplace (Jiji) A complete autopilot integration for a two-sided marketplace like Jiji — events, mapping, stages, and campaigns.
- Example: Subscription / Media (Showmax) A complete autopilot integration for a streaming service like Showmax — events, mapping, stages, and campaigns.
- Example: Fintech / Neobank (Kuda) A complete autopilot integration for a digital bank like Kuda — events, mapping, stages, and campaigns.
- Example: On-demand (Shuttlers) A complete autopilot integration for a shared-mobility service like Shuttlers — events, mapping, stages, and campaigns.
Use Cases
- Cart abandonment recovery Recover shoppers who add items to their cart but leave without buying, using an event-triggered EngageApp campaign.
- Post-purchase follow-up Turn a one-time buyer into a repeat customer with a well-paced sequence that runs after every purchase.
- Win-back & re-engagement Re-engage customers who have gone quiet with a targeted incentive and a persistent, multi-channel follow-up.
- SaaS user onboarding Guide new signups to their activation moment with a welcome sequence that adapts to whether they get set up.
- Feature adoption Drive usage of a specific feature by targeting active users who have not tried it yet and following up until they do.
- Lifecycle & drip campaigns Build a multi-step nurture that unfolds over days or weeks and branches so each contact gets a relevant path.
Billing & Account
- Billing & credits How EngageApp prepaid, credit-based billing works — per-channel credit costs, your wallet, the ledger, and low-balance handling.
- Topping up How to add credits to your workspace wallet with Flutterwave, and how settlement is handled safely.
- Team & roles Invite members to your workspace and control what they can access with owner, admin, and member roles.
- API keys Create and manage secret and publishable API keys to authenticate server-side calls and client SDKs.
Developers
- Server-side integration guide Connect EngageApp to your backend with a secret API key — sync contacts, track events, and enroll contacts into campaigns.
- Public API reference The public HTTP API for server-side and SDK integrations — authentication headers and endpoints.
- Web SDK reference API reference for @engageapp/inapp-web — init, identify, onAppForeground, setHandlers, and dismiss.
- Flutter SDK reference API reference for engageapp_inapp — navigator-key setup, init, identify, onAppForeground, and setHandlers.