/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3

    List auto event messages

    Copy link

    Retrieves a list of auto event messages that are sent in a specified application and indicates which ones are in use. Auto event messages are Admin messages that are automatically generated when a specific event occurs.

    Note: Auto event messages are only available for group channels.

    HTTP request

    Copy link
    GET https://api-{application_id}.sendbird.com/v3/applications/settings/auto_event_message
    

    Note: If you are using the in-app channel in Delight AI agent, the endpoint for your API request should start with https://api-{application_id}.svc.delight.ai/v3 instead of https://api-{application_id}.sendbird.com/v3. For more details, refer to our Delight AI agent guide.

    Response

    Copy link

    If successful, this action returns information on which auto event messages are in use for the specified application in the response body.

    {
    "auto_event_message": {
        "user_leave": {
            "deleted": false,
            "deactivated": false,
            "left": false,
            "admin_removed": true,
            "admin_deleted": true,
            "admin_deactivated": true,
            "left_by_own_choice": true,
            "channel_operator_removed": true
        },
        "user_join": {
            "user_join": true
        },
        "channel_create": {
            "public_channel": true,
            "private_channel": true
        },
        "channel_change": {
            "channel_change": false
        }
    }