Skip to main content
Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API
    /
    Webhook

    Announcement

    This page shows webhook events related to announcements within your Sendbird application.

    announcement:create_channels

    This webhook event is invoked when channels are created for sending an announcement to target users who do not already have a channel with the announcement sender. The following shows a webhook payload for a announcement:create_channels event.

    {
    "category": "announcement:create_channels",
    "announcement_id": "Announcement202012250130",
    "announcement_group": "Promotion message",
    "created_at": 1608859853231,
    "channel": [
        {
            "name": "Promotion Channel",
            "channel_url": "sendbird_group_channel_6837203_a94nkd98839snakd093jkjsank33jdiw",
            "custom_type": "",
            "data": "",
            "is_distinct": true,
            "is_public": false,
            "is_super": false,
            "is_ephemeral": false,
            "is_discoverable": false,
        }
    ]
    "app_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

    announcement:send_messages

    The webhook event is invoked when an announcement message is sent to target channels and users. The following shows a webhook payload for a announcement:send_messages event.

    {
    "category": "announcement:send_messages",
    "announcement_id": "Announcement202012250130",
    "announcement_group": "Promotion message",
    "created_at": 1608859853231,
    "sender": {
        "user_id": "Jin",
        "nickname": "JinJin",
        "profile_url": "https://sendbird.com/main/img/profiles/profile_26_512px.png",
        "metadata": {}
    },
    "channel": [
        {
            "name": "Promotion Channel",
            "channel_url": "sendbird_group_channel_6837203_a94nkd98839snakd093jkjsank33jdiw",
            "custom_type": "",
            "data": "",
            "is_distinct": true,
            "is_public": false,
            "is_super": false,
            "is_ephemeral": false,
            "is_discoverable": false,
            "members": [
                {
                    "user_id": "JinJin",
                    "nickname": "Jin",
                    "profile_url": "https://sendbird.com/main/img/profiles/profile_26_512px.png",
                    "metadata": {}
                }
            ]
        }
    ],
    "message": {
        "content": "Here is my friend's profile! https://xxx.com/img/profiles/sally.jpg",
        "type": "CMD",
        "custom_type": "",
        "data": ""
    },
    "app_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}