Events
Confused about "Events"?
Let us know how we can improve our documentation:
- On This Page:
- Webhook Event Types
- message.new
- message.read
- message.updated
- message.deleted
- message.flagged
- message.flagged - automoderation
- reaction.new
- reaction.deleted
- member.added
- member.updated
- member.removed
- channel.created
- channel.updated
- channel.hidden
- channel.deleted
- channel.muted
- user.banned
- user.deactivated
- user.deleted
- user.reactivated
- user.unbanned
- user.updated
- user.unread_message_reminder
Below you can find the complete list of events that are sent via webhooks together with the description of the data payload.
For message and channel events the webhook request body will also include the list of channel members and attach additional information about their read status. For performance reasons, such list is truncated up to 50 members.
When applicable, the following attributes are included to the event user and to the event members:
total_unread_count | the total count of messages across all channels. |
unread_channels | the count of channels with at least one unread message. |
channel_last_read_at | the last time the channel was marked as read. |
channel_unread_count | the count of unread messages on this channel |
Webhook Event Types
Copied!Confused about "Webhook Event Types"?
Let us know how we can improve our documentation:
Event | Triggered |
---|---|
message.new | when a new message is added. |
message.read | when a user calls mark as read. |
message.updated | when a message is updated. |
message.deleted | when a message is deleted. |
message.flagged | when a message is flagged. |
reaction.new | when a message reaction is added. |
reaction.deleted | when a message reaction deleted |
reaction.updated | when a reaction is updated. |
member.added | when a member is added to a channel. |
member.updated | when a member is updated. |
member.removed | when a member is removed from a channel. |
channel.created | when a channel is created. |
channel.updated | when a channel is updated. |
channel.muted | when a channel is muted. |
channel.unmuted | when a channel is unmuted. |
channel.truncated | when a channel is truncated. |
channel.deleted | when a channel is deleted. |
channel.hidden | when a channel is hidden. |
user.deactivated | when a user is deactivated |
user.deleted | when a user is deleted |
user.reactivated | when a user is reactivated |
user.updated | when a user is updated. |
user.muted | when a user is muted. |
user.unmuted | when a user is unmuted. |
user.banned | when a user is banned. |
user.unbanned | when a user is unbanned. |
user.flagged | when a user is flagged. |
user.unread_message_reminder | when the user has at least 1 unread message (see reminders section) |
message.new
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
message.read
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
message.updated
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
message.deleted
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
message.flagged
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
message.flagged - automoderation
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
reaction.new
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
reaction.deleted
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
member.added
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
member.updated
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
member.removed
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
channel.created
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
channel.updated
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
channel.hidden
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
channel.deleted
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
channel.muted
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
user.banned
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
user.deactivated
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
user.deleted
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
user.reactivated
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
user.unbanned
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
user.updated
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation:
user.unread_message_reminder
Copied!Confused about "[object Object]"?
Let us know how we can improve our documentation: