Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API

    Operators

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


    operators:register_by_operator

    This webhook event is invoked when one or more operators are registered by another operator's client app. The following shows a webhook payload of a operators:register_by_operator event.

    {
        "category": "operators:register_by_operator",
        "requested_at": 1540867938000,
        "requester": {
            "user_id": "David",
            "nickname": "TallAndStrong",
            "profile_url": "https://sendbird.com/main/img/profiles/profile_30_512px.png",
            "metadata": {}
        },
        "channel_type": "group_channel",
        "channel": {
            "name": "Sport center members",
            "channel_url": "sendbird_group_channel_6122393_1379dd647e15ddb2471c933794b6cb4651498933",
            "cover_url": "https://sendbird.com/main/img/cover/cover_43.jpg",
            "custom_type": "personal",
            "is_distinct": true,
            "is_public": false,
            "is_super": false,
            "is_ephemeral": false,
            "is_discoverable": false,
            "data": ""
        },
        "operators": [
            {
                "user_id": "Tei",
                "nickname": "Uaena",
                "profile_url": "https://sendbird.com/main/img/profiles/profile_142_512px.png",
                "metadata": {}
            },
            ... # More operators
        ],
        "app_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
    

    operators:unregister_by_operator

    This webhook event is invoked when the registration of one or more operators is canceled by another operator's client app. The following shows a webhook payload of a operators:unregister_by_operator event.

    {
        "category": "operators:unregister_by_operator",
        "requested_at": 1540867938323,
        "requester": {
            "user_id": "David",
            "nickname": "TallAndStrong",
            "profile_url": "https://sendbird.com/main/img/profiles/profile_30_512px.png",
            "metadata": {}
        },
        "channel_type": "group_channel",
        "channel": {
            "name": "Sport center members",
            "channel_url": "sendbird_group_channel_6122393_1379dd647e15ddb2471c933794b6cb4651498933",
            "cover_url": "https://sendbird.com/main/img/cover/cover_43.jpg",
            "custom_type": "personal",
            "is_distinct": true,
            "is_public": false,
            "is_super": false,
            "is_ephemeral": false,
            "is_discoverable": false,
            "data": ""
        },
        "operators": [
            {
                "user_id": "Glen",
                "nickname": "YoungAndTall",
                "profile_url": "https://sendbird.com/main/img/profiles/profile_52_512px.png",
                "metadata": {}
            },
            ... # More operators
        ],
        "app_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }