Group channel
This page shows webhook events related to group channels within your Sendbird application.
group_channel:create
This webhook event is invoked when a group channel is created through the Chat API or SDKs. For members who are invited as channel member when creating the channel will receive group_channel:join
. The group_channel:invite
webhook isn't invoked in this case.
The following shows a webhook payload of a group_channel:create
event.
Note: By default, the
members
property is excluded from the payload. To includemembers
, turn on the Include member information option under Settings > Chat > Webhooks on Sendbird Dashboard. Regardless of this option, webhook payloads of Supergroup channels don't include member information.
group_channel:changed
This webhook event is invoked and delivered when one of the following group channel properties has been changed: name
, cover_url
, custom_type
, channel_type
, data
, and access_code
. The changes
property in the payload contains the old
and new
values of the changed channel properties. The following shows a webhook payload of a group_channel:changed
event.
Note: By default, the
members
property is excluded from the payload. To includemembers
, turn on the Include member information option under Settings > Chat > Webhooks on Sendbird Dashboard. Regardless of this option, webhook payloads of Supergroup channels don't include member information.
group_channel:remove
This webhook event is invoked when a group channel is removed. The following shows a webhook payload of a group_channel:remove
event.
group_channel:invite
This webhook event is invoked when a user invites another user. The following shows a webhook payload of a group_channel:invite
event.
Note: By default, the
members
property is excluded from the payload. To includemembers
, turn on the Include member information option under Settings > Chat > Webhooks on Sendbird Dashboard. Regardless of this option, webhook payloads of Supergroup channels don't include member information.
group_channel:decline_invite
This webhook event is invoked when a user declines an invitation. The users
property indicates the members who have declined invitations and are in pending status. The following shows a webhook payload of a group_channel:decline_invite
event.
Note: By default, the
members
property is excluded from the payload. To includemembers
, turn on the Include member information option under Settings > Chat > Webhooks on Sendbird Dashboard. Regardless of this option, webhook payloads of Supergroup channels don't include member information.
group_channel:join
This webhook event is invoked when a user joins a group channel. The users
property indicates members who have accepted invitations or joined the channel while auto_accept
is set to true
. The following shows a webhook payload of a group_channel:join
event.
Note: By default, the
members
property is excluded from the payload. To includemembers
, turn on the Include member information option under Settings > Chat > Webhooks on Sendbird Dashboard. Regardless of this option, webhook payloads of Supergroup channels don't include member information.
group_channel:leave
This webhook event is invoked when a user leaves a group channel. The users
property indicates those who have left a group channel, whereas the members
indicates those who still remain in the channel. The channel_unread_message_count
is a value for a user's unread message count of the channel when the user left. The following shows a webhook payload of a group_channel:leave
event.
Note: By default, the
members
property is excluded from the payload. To includemembers
, turn on the Include member information option under Settings > Chat > Webhooks on Sendbird Dashboard. Regardless of this option, webhook payloads of Supergroup channels don't include member information.
group_channel:message_send
This webhook event is invoked when a message is sent within a group channel. The following shows a webhook payload of a group_channel:message_send
event.
Note: By default, the
members
property is excluded from the payload. To includemembers
, turn on the Include member information option under Settings > Chat > Webhooks on Sendbird Dashboard. Regardless of this option, webhook payloads of Supergroup channels don't include member information.
group_channel:message_read
This webhook event is invoked when a user has no more unread messages in a group channel. The following shows a webhook payload of a group_channel:message_read
event.
Note: By default, the
members
property is excluded from the payload. To includemembers
, turn on the Include member information option under Settings > Chat > Webhooks on Sendbird Dashboard. Regardless of this option, webhook payloads of Supergroup channels don't include member information.
group_channel:message_update
This webhook event is invoked and delivered when one of the following message properties is updated: message
, custom_type
, data
, mention_type
, message_events
, and mentioned_user_ids
. The changes
property in the payload contains the old
and new
values of the changed message properties. The following shows a webhook payload of a group_channel:message_update
event.
Note: By default, the
members
property is excluded from the payload. To includemembers
, turn on the Include member information option under Settings > Chat > Webhooks on Sendbird Dashboard. Regardless of this option, webhook payloads of Supergroup channels don't include member information.
group_channel:message_delete
This webhook event is invoked when a message is deleted from a group channel. The following shows a webhook payload of a group_channel:message_delete
event.
Note: By default, the
members
property is excluded from the payload. To includemembers
, turn on the Include member information option under Settings > Chat > Webhooks on Sendbird Dashboard. Regardless of this option, webhook payloads of Supergroup channels don't include member information.
group_channel:freeze_unfreeze
This webhook event is invoked when a channel operator freezes or unfreezes a group channel. The default value for freeze
is false
. The following shows a webhook payload of a group_channel:freeze_unfreeze
event.
group_channel:reaction_add
This webhook event is invoked when a user adds reactions to a message. The following shows a webhook payload of a group_channel:reaction_add
event.
group_channel:reaction_delete
This webhook event is invoked when a user deletes reactions from a message. The following shows a webhook payload of a group_channel:reaction_delete
event.