Business Messaging User Guide v2
Business Messaging
Version 2

Webhooks

Copy link

Webhooks can notify teams when a certain event takes place in regard to templates and notifications. Set Notification webhooks on Sendbird Dashboard for your server to receive HTTP POST requests from the Sendbird server in JSON format, which contain information on all events within your Sendbird application.


Set up webhooks

Copy link
  1. Log in the Sendbird Dashboard.
  2. Navigate to Settings > Business Messaging > Webhooks and turn on the feature.
  3. Enter the webhook URL for the Sendbird server to send a request and choose the events you wish to subscribe to.

SettingsDescription

URL

Specifies the URL that Sendbird can send the the payload to.

Events

Selects webhook events to listen to.
Refer to the table below for the supported events.

List of webhook events

Copy link

The following table lists the webhook events that you can subscribe to.

EventDescription

notification:send_realtime

Notifies you when a request is made for a real-time notification.

notification:send_batch

Notifies you when a request is made for a batch notification.

notification:template_create

Notifies you when a template is created.

notification:template_archive

Notifies you when a template is archived.

notification:template_unarchive

Notifies you when a template is unarchived.

notification:template_edit

Notifies you when a template is edited.

notification:template_approval_update

Notifies you when the approval status of a channel’s template has changed.

Note: To learn more about how to set up the environment for webhook subscription and sample payload, see our server-side guide on Webhooks.