Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cometchat-22654f5b-docs-campaigns-service-rest-api.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

CometChat Campaigns is a notification management system that lets you design, target, and deliver in-app and push notifications to your users. It provides a visual dashboard for creating notification templates, managing delivery channels, and sending targeted campaigns — either immediately or on a schedule. Your backend can also send notifications programmatically via API.

Key Capabilities

  • Send transactional notifications — Deliver a templated message to one or many users in real time, with per-recipient variable resolution.
  • Organise content with templates — Author reusable templates with typed variables, categories, and tags. Every notification flows through a template.
  • Run scheduled and batch campaigns — Send to a handful of users immediately or to tens of thousands through batch and CSV-driven flows.
  • Track delivery and engagement — Capture delivered, read, clicked, and interacted signals for analytics and unread counts.
  • Administer the in-app feed — Soft-delete feed items, audit per-user delivery, and manage retention.

Supported Channels

ChannelDescription
in_appIn-app notification feed rendered client-side via SDK
pushPush notifications delivered via FCM/APNs through CometChat’s push infrastructure

Setup Flow

The typical setup to send your first notification:
1

Create a Channel

Go to Channels → Create Channel → Select type (in_app or push) → Name it → Save.
2

Create a Category (optional)

Go to Categories → Create → Name it (e.g., “Marketing”, “Alerts”).
3

Create a Template

Go to Templates → Create Template → Enter name → Select channel(s) → Design content in the visual builder → Set status to “Approved”.
4

Send a Notification

Either via Dashboard (Create a Campaign → Select template → Add recipients → Send Now) or via API (POST /notifications/messages).

Prerequisites

  • A CometChat app with appId and apiKey
  • At least one enabled channel created
  • At least one approved template
  • Users registered in CometChat (targeted by their UID)

Limits

ResourceLimit
Recipients per notification (realtime)10
Recipients per notification (batch)10,000
Pagination page sizeMax 100
Max campaignsNo hard limit
Max templatesNo hard limit

Common Use Cases

Transactional alerts

Order shipped, payment receipt, password reset, security alert. One templated message per event, dispatched in real time, with per-recipient variable substitution ({{order_id}}, {{user_name}}).

Marketing campaigns

Product launches, promotional offers, re-engagement nudges. Schedule the send, upload a recipient list, and deliver across in-app and push channels.

Operational messages

Maintenance windows, policy updates, account changes. Dispatched to a broad audience and routed through the in-app feed so users can revisit them.

Quick Navigation

Channels

Configure delivery channels for in-app and push notifications

Categories

Organize notifications with categories for filtering

Templates

Create reusable notification templates with variables and versioning

Campaigns

Create and manage targeted notification campaigns