Chat subscriptions

The information in the team_chat_subscription section of the manifest JSON represents the values on the Surface > Chat Subscriptions page of the app build flow.

Manifest JSON

{
    "features": {
        // ......
        "team_chat_subscription": {
            "enable": true,
            "slash_command": {
                "command": "",
                "command_hints": [
                    {
                        "description": "",
                        "usage_hint": ""
                    },
                    {
                        "description": "",
                        "usage_hint": ""
                    }
                ],
                "enable_mention": true,
                "development_message_url": "",
                "production_message_url": "",
                "sender_type": "zoom",
                "welcome_msg": {
                    "title": "title",
                    "body": "body"
                },
                "trust_domain_list": [
                    {
                        "domain": "",
                        "unfurling": true
                    },
                    {
                        "domain": "",
                        "unfurling": false
                    }
                ]
            },
            "shortcuts": [
                {
                    "action_label": "actionName",
                    "action_id": "actionCommandId",
                    "action_types": ["COMPOSE_BOX"],
                    "action_usage": "DIALOG",
                    "dialog_config": {
                        "title": "www",
                        "size": "S"
                    }
                }
            ]
        }
        // ......
    }
}

Field Description

Field	Description	Required
`enable`	Required for creating a chat bot. This subscription allows this bot to send and receive chat messages in Zoom Client.	No
`slash_command.command`	Name of your slash command that users can invoke to interact with this bot	No
`slash_command.development_message_url`	This scope is automatically selected once you create a Chat Command: `Required imchat:bot`	No
`slash_command.production_message_url`	This scope is automatically selected once you create a Chat Command: `Required imchat:bot`	No
`slash_command.command_hints[].usage_hint`	A string hint about how to use the slash command for users.	No
`slash_command.command_hints[].description`	A string containing a description of the slash command that will be displayed to users.	No
`slash_command.trust_domain_list`	Enter any known domains that are safe for users to access when referenced in your chatbot messages.	No
`slash_command.sender_type`	Send a first message by Zoom App Marketplace or Your App Values: `zoom` / `own`	No
`slash_command.welcome_msg`	Zoom App Marketplace will send a Webhook event to your app when this chatbot app is installed.	No
`slash_command.enable_mention`	Enable if your app can receive and respond to @mentions in Chat.	No
`shortcuts[].shortcut_id`	The primary key of shortcut	Yes (when updating shortcut)
`shortcuts[].action_label`	The action name will appear in Zoom Chat. Name it in a simple and clear way	Yes (for each shortcut included)
`shortcuts[].action_id`	The command ID will be used to identify your app shortcuts. This is not visible to your users.	Yes (for each shortcut included)
`shortcuts[].action_type`	The command ID will be used to identify your app shortcuts. This is not visible to your users.	Yes (for each shortcut included)
`shortcuts[].dialog_config.title`	The dialog title reflects the action name.	No
`shortcuts[].dialog_config.size`	Choose the action dialog size to better fit your content. "S"/"M"/"L"	No