Chat Platform API v3
Chat Platform API
Chat Platform API
Version 3
Report
Copy link
This page shows webhook events related to reports within your Sendbird application.
message:report
Copy link
This webhook event is invoked when a message is reported by a user. The following shows a webhook payload of a message:report
event.
{ "category": "message:report", "created_at": 1568791754, "report_type": "message", "report_category": "suspicious", "reporting_user": { "user_id": "Matthew", "nickname": "Mooch", "profile_url": "https://sendbird.com/main/img/profiles/profile_44_512px.png", "metadata": { "font_preference": "times new roman", "font_color": "gray" } }, "offending_user": { "user_id": "Jane", "nickname": "Trinity", "profile_url": "https://sendbird.com/main/img/profiles/profile_432_512px.png", "metadata": { "font_preference": "times new roman", "font_color": "gray" } }, "reported_message": { "sender": { "user_id": "Jane", "nickname": "Trinity", "profile_url": "https://sendbird.com/main/img/profiles/profile_432_512px.png", "metadata": { "font_preference": "times new roman", "font_color": "gray" } }, "type": "MESG", "custom_type": "", "mention_type": "users", "mentioned_users": [], "payload": { "message_id": 592281302, "custom_type": "", "message": "Seriously, I am waiting for you at my secret website. Would you join me?", "translations": {}, "data": "", "created_at": 1568784875135 }, "channel": { "name": "Looking for someone to spend my time with...", "channel_url": "sendbird_group_channel_15110744_67c34500c14ffa4f9ad23a80d4426e40467ebb91", "custom_type": "", "is_distinct": true, "is_public": false, "is_super": false, "is_ephemeral": false, "is_discoverable": false, "data": "" }, "sdk": "Android" // iOS, Android, JavaScript, .NET or API }, "channel": { "name": "Looking for someone to spend my time with...", "channel_url": "sendbird_group_channel_15110744_67c34500c14ffa4f9ad23a80d4426e40467ebb91", "custom_type": "", "is_distinct": true, "is_public": false, "is_super": false, "is_ephemeral": false, "is_discoverable": false, "data": "" }, "app_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }
user:report
Copy link
This webhook event is invoked when a user is reported by another user. The following shows a webhook payload of a user:report
event.
{ "category": "user:report", "created_at": 1568775527, "report_type": "user", "report_category": "harassing", "reporting_user": { "user_id": "Elizabeth", "nickname": "Rolly Rolly", "profile_url": "https://sendbird.com/main/img/profiles/profile_471_512px.png", "metadata": { "font_preference": "times new roman", "font_color": "gray" } }, "offending_user": { "user_id": "Drake", "nickname": "TooLate", "profile_url": "https://sendbird.com/main/img/profiles/profile_432_512px.png", "metadata": { "font_preference": "times new roman", "font_color": "gray" } }, "channel": { "name": "PBR&B songs", "channel_url": "sendbird_group_channel_15458190_3ce474cfbb465c513de1728c7283bec63f00deea", "custom_type": "", "is_distinct": true, "is_public": false, "is_super": false, "is_ephemeral": false, "is_discoverable": false, "data": "" }, "app_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }
open_channel:report
Copy link
This webhook event is invoked when an open channel is reported by a user. The following shows a webhook payload of a open_channel:report
event.
{ "category": "open_channel:report", "created_at": 1568738756, "report_type": "channel", "report_category": "suspicious", "reporting_user": { "user_id": "Jay", "nickname": "Rooster", "profile_url": "https://sendbird.com/main/img/profiles/profile_13_512px.png", "metadata": { "font_preference": "times new roman", "font_color": "gray" } }, "channel": { "name": "Come on girls!", "channel_url": "sendbird_open_channel_eb4678e83afeb815582b97ec41faf71a59bb7708", "custom_type": "", "is_distinct": false, "is_public": false, "is_super": false, "is_ephemeral": false, "is_discoverable": false, "data": "" }, "app_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }
group_channel:report
Copy link
This webhook event is invoked when a group channel is reported by a user. The following shows a webhook payload of a group_channel:report
event.
{ "category": "group_channel:report", "created_at": 1568738756, "report_type": "channel", "report_category": "inappropriate", "report_description": "use of offensive language", "reporting_user": { "user_id": "Debbie", "nickname": "Eclipse", "profile_url": "https://sendbird.com/main/img/profiles/profile_183_512px.png", "metadata": { "font_preference": "times new roman", "font_color": "gray" } }, "channel": { "name": "Talking dirty with me tonight...", "channel_url": "sendbird_group_channel_15458667_8d00f8ff213349e24b8c6e0fc17bc5111d66f0fc", "custom_type": "", "is_distinct": true, "is_public": false, "is_super": false, "is_ephemeral": false, "is_discoverable": false, "data": "" }, "app_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }