Skip to main content

Creating Announcements

What Are Announcements

Announcements are in-app messages used to communicate updates, feature releases, maintenance notices, and other information to your users. They appear directly within your application, ensuring users see important messages without relying on email or external channels.

Announcement Types

BreakGround supports four announcement formats. Choose the type that matches the importance and context of your message:

TypeDescription
MODALA centered overlay dialog with a backdrop. Captures full attention. Best for critical updates, feature launches, or messages requiring user acknowledgment.
BANNERA bar displayed at the top or bottom of the viewport. Visible but non-blocking. Best for maintenance notices, status updates, or promotions.
SLIDEOUTA panel that slides in from the side of the screen. Provides more space for content than a banner. Best for changelogs, detailed feature announcements, or multi-paragraph messages.
TOASTA small notification in the corner of the screen that auto-dismisses after a timeout. Least intrusive. Best for confirmations, minor updates, or transient messages.

Creating an Announcement

  1. Navigate to Content > Announcements in the dashboard.
  2. Click Create New Announcement.
  3. Select the announcement type (Modal, Banner, Slideout, or Toast).
  4. Enter the announcement title and body content using the rich text editor.
  5. Optionally add one or more CTA buttons (e.g., "Learn More", "Try It Now") with link URLs or custom actions.
  6. Configure targeting and scheduling.
  7. Click Save to create the announcement in DRAFT status, or Publish to make it live immediately.

Content Options

The rich text editor supports:

  • Formatted text (headings, bold, italic, lists).
  • Inline images and media embeds.
  • CTA buttons with configurable labels, URLs, and styles (primary, secondary, text link).
  • Custom HTML for advanced layouts.

Trigger Types

Configure when the announcement appears. The trigger fires independently of the schedule — an announcement only shows if its trigger fires within its active scheduledAt/expiresAt window.

TriggerFires whenKey config
exit_intentThe user's cursor moves toward the browser chrome, indicating intent to leave.
scroll_depthThe user scrolls past a specified percentage of the page.percentage (0–100), url
time_on_pageThe user has spent a set duration on the page.delay (ms), url
side_buttonThe user clicks a persistent launcher button on the side of the viewport.buttonColor, buttonPosition
url_matchThe current URL matches a pattern.pattern, matchType
manualProgrammatically via DAP('showContent', announcementId).

Tip: Use exit_intent for upgrade or trial announcements — they appear just before a user leaves, when conversion intent is highest.

Scheduling

Announcements can be published immediately or scheduled for a future date:

  • Immediate -- The announcement goes live as soon as you publish it.
  • Scheduled (scheduledAt) -- Set a future date and time for the announcement to activate automatically.
  • Expiry (expiresAt) -- Set an end date after which the announcement is automatically deactivated.

Announcements with both scheduledAt and expiresAt are active only during the specified window.

Managing Announcements

From the Content > Announcements list, you can:

  • Filter by status (DRAFT, PUBLISHED, SCHEDULED, ARCHIVED).
  • Duplicate an announcement to reuse its content and settings.
  • Archive a published announcement to deactivate it.
  • Preview any announcement to see how it appears to end users.