Skip to content

docs(webhooks): Add campaign events documentation #367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
swapnil-cometchat merged 1 commit into from
May 29, 2026
+426 −0
Merged

docs(webhooks): Add campaign events documentation #367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions fundamentals/webhooks-overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,4 +155,21 @@ CometChat supports webhook triggers for different categories of events. Click ea

***

### Campaign Events

| Event | Description |
| ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| [after\_campaign\_completed](/fundamentals/webhooks#after_campaign_completed) | Triggered when a campaign finishes sending to all targets. |
| [after\_campaign\_failed](/fundamentals/webhooks#after_campaign_failed) | Triggered when a campaign fails to deliver to its targets. |
| [after\_notification\_created](/fundamentals/webhooks#after_notification_created) | Triggered when a notification is created and begins dispatching. |
| [after\_feed\_item\_sent](/fundamentals/webhooks#after_feed_item_sent) | Triggered when an in-app feed item is sent to a user. |
| [after\_feed\_item\_delivered](/fundamentals/webhooks#after_feed_item_delivered) | Triggered when a feed item is delivered to the user's device. |
| [after\_feed\_item\_read](/fundamentals/webhooks#after_feed_item_read) | Triggered when a user reads a feed item. |
| [after\_feed\_item\_interacted](/fundamentals/webhooks#after_feed_item_interacted) | Triggered when a user interacts with a feed item. |
| [after\_push\_notification\_sent](/fundamentals/webhooks#after_push_notification_sent) | Triggered when a push notification is sent. |
| [after\_push\_notification\_delivered](/fundamentals/webhooks#after_push_notification_delivered) | Triggered when a push notification is delivered to the user's device. |
| [after\_push\_notification\_clicked](/fundamentals/webhooks#after_push_notification_clicked) | Triggered when a user clicks on a push notification. |

***

By following this guide, you can seamlessly integrate CometChat webhooks into your system and build event-driven experiences at scale.
3 changes: 3 additions & 0 deletions fundamentals/webhooks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ Notifications for voice/video call events including initiation, start, end, part
### Moderation Events
Notifications for content moderation outcomes including auto-approved, auto-blocked, and manually approved messages.

### Campaign Events
Notifications for campaign lifecycle events including campaign completion, failure, notification creation, feed item delivery (sent, delivered, read, interacted), and push notification delivery (sent, delivered, clicked).

## Webhook Requirements

Your webhook endpoint must:
Expand Down
Loading