Skip to content

docs(readme): onReaction example + reaction.received in webhook setup #5

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
mikipalet merged 1 commit into from
May 21, 2026
Merged

docs(readme): onReaction example + reaction.received in webhook setup #5

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
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Connect the social accounts you want your bot to handle through the Zernio dashb
Create a webhook in your Zernio dashboard pointing to your bot's webhook endpoint:

- **URL**: `https://your-app.com/api/chat-webhook`
- **Events**: Select `message.received` and `comment.received`
- **Events**: Select `message.received` and `comment.received`. Add `reaction.received` if you handle reactions (routes to `bot.onReaction`).
- **Secret**: Set a strong secret and pass it as `ZERNIO_WEBHOOK_SECRET`

### 4. Enable the Inbox Addon
Expand Down Expand Up @@ -200,6 +200,24 @@ bot.onNewMessage(/.*/, async (thread, message) => {
});
```

## Receiving Reactions

Reactions (WhatsApp and Telegram) route to `onReaction`, not `onNewMessage`, so a 👍 is never treated as an inbound message. Subscribe your webhook to `reaction.received` to receive them.

```typescript
bot.onReaction(async (event) => {
// event.emoji normalized emoji (use event.rawEmoji for the raw platform value)
// event.added true when added, false when removed
// event.messageId the message that was reacted to
// event.thread the thread where it happened
if (event.added) {
await event.thread.post(`Thanks for the ${event.emoji}!`);
}
});
```

> Telegram only delivers reactions when the bot is an administrator in the chat (never in private chats). On WhatsApp removals the emoji is reported as an empty string.

## Platform-Specific Data

Access the underlying platform through the raw message:
Expand Down
Loading