Skip to main content
Configure webhooks and push notification infrastructure to stream real-time events and engage users reliably.

Webhooks

Deliver real-time events to your backend

Certificates

Upload APNs / FCM / Baidu credentials

Chat Events

Channel & conversation notifications

Community Events

Post, comment, story & event notifications

Live Stream Events

Standalone live stream notifications

Custom Payloads

Tailor notification content per event

​
Webhooks

Need full event catalog, payload schema, retry logic, and signature details? See the complete reference: Webhook Events Reference.
1

Add Endpoint

Enter HTTPS URL in Settings → Webhook section.
2

Secret Issued

Console generates secret key tied to that URL.
3

Validate Signature

Configure backend to verify HMAC (secret) per event.
4

Rotate Secret

Delete & re-add endpoint if compromise suspected.
Use publicly reachable HTTPS endpoints; avoid including query secrets in the URL.
Idempotent processing, 200 fast ACK then async work, exponential retry logic on your side.
Restrict IPs if possible; verify signature before queuing work.
Include event schema version in payload to future‑proof consumers.

​
Push Notifications

Navigate to Settings → Push notifications in the console to manage notification settings and certificates. Push notifications overview

​
Enable Push Notifications

Use the master toggle at the top of the page to enable or disable push notifications for the entire network.
Turning the master toggle OFF immediately disables all push events (Chat, Community, Live Stream). Certificates must be uploaded and active before toggling events, or notifications will silently fail.

​
Certificates

Multiple certificates can be stored per platform (e.g., staging + production), but only one can be active at a time per platform/provider.
Starting June 01, 2024, Google will no longer support mobile push notifications via legacy FCM v1 APIs. Migrate to FCM v1 before this date.
FieldPlatform ScopePurpose
Certificate NameAllInternal tracking label
PlatformiOS / AndroidTarget OS
Provider (Android)AndroidFirebase Cloud Messaging (FCM) / Baidu Cloud Push
Service Account JSON (FCM)AndroidFCM v1 service account credentials
.p12 / .p8 UploadiOSAPNs authentication material
Credential PasswordiOSPassword for .p12 if set
1

Prepare Credential

Obtain APNs .p12/.p8 certificate or FCM service account JSON / Baidu server keys.
2

Upload

Console → Settings → Push notifications → Certificates → Add new certificate.
3

Activate

Toggle the Active switch for the certificate you want to use per environment.
4

Verify

Send a test notification to confirm delivery.
Keep staging & production certificates clearly labeled to avoid cross‑environment delivery errors.

​
Notification Events

Configure which events trigger push notifications. Events are organized into three tabs: Chat events configuration
Chat-related push notification events:
EventDescription
When a new channel is createdNotifies users when a new channel is created
When a user joins a channelNotifies when a user joins a channel
When a user joins a conversationNotifies when a user joins a conversation
When there is a new message in the users channelNotifies on new messages in channels
When there is a new message in the users conversationNotifies on new messages in conversations
Each event has an Allow toggle and an Actions button to customize the notification message.

​
Custom Push Message

Click the Actions (pencil icon) button next to any event to customize the notification message template. Keep messages concise (<140 chars) and actionable.
Store translation keys instead of raw strings; expand at client side.
Include displayName when appropriate but avoid sensitive content in payload.
Throttle bursts to prevent notification fatigue.

​
Monitoring & Metrics

MetricDescriptionTrigger
Delivery Success %Successful pushes / totalDrop < 95% → inspect certs & provider status
Cert Days to ExpirySoonest certificate expiry< 30 days → schedule renewal
Event CoverageEnabled events / intended eventsGap → enable missing categories
Webhook Failure Rate4xx/5xx responses / total deliveries> 2% → investigate endpoint health

​
Troubleshooting

IssueLikely CauseFix
No push deliveredInactive certificateActivate correct cert in Certificates table
Some events silentEvent toggle offEnable event under the appropriate tab
FCM legacy errorsUsing deprecated FCM v1 APIMigrate to FCM v1 with service account JSON
Webhook 401 errorsSecret mismatchRegenerate secret and update backend
Elevated retriesEndpoint latencyOptimize processing / return 200 quickly
Duplicate notificationsMissing idempotencyTrack delivery IDs, discard repeats

​
Quick Reference

Master Toggle

Enables all downstream push events

Active Cert

One active per platform/provider

Rotate Window

Renew ≥30 days before expiry

Webhook Security

Verify signature HMAC

Security

Secure Mode & mTLS

Branding

Console visuals & brand account