Manifest template

View as Markdown

For your convenience, this is a display of the manifest JSON with some sample data. For details, see the respective articles about each section.

Best practice: always use the latest version

It is very important that you use the latest version of the manifest template, or else it may fail validation. The best practice is to download the latest template from the app creation screen.

For more information, see the Manifest overview.


{
    "developer_information":
    {
        "business_information":
        {
            "address": "",
            "bank_account_number": "",
            "bank_name": "",
            "email": "",
            "enable": true,
            "name": "",
            "phone": "",
            "registration_number": ""
        },
        "contact_details":
        [
            {
                "contact_email": "",
                "contact_name": "",
                "role": ""
            }
        ]
    },
    "display_information":
    {
        "business_lines":
        [
            "humanResources",
            "marketing"
        ],
        "config_url": "",
        "description": "description",
        "discover_type": "LISTED",
        "display_name": "Manifest ApplicationName",
        "doc_url": "",
        "industry_vertical": "health_care",
        "install_type": "APP_DIRECTORY",
        "long_description": "long_description",
        "market_segments":
        [
            "consumer"
        ],
        "marketplace_categories":
        [
            "analytics",
            "broadcasting-streaming"
        ],
        "privacy_url": "",
        "support_url": "",
        "terms_url": ""
    },
    "features":
    {
        "connect": {},
        "custom_form": {},
        "development_home_uri": "",
        "domain_allow_list":
        [
            {
                "domain": "",
                "explanation": ""
            }
        ],
        "embed":
        {
            "contact_center_sdk":
            {
                "enable": false
            },
            "meeting_sdk":
            {
                "devices":
                [],
                "enable": false,
                "enable_device": false
            },
            "phone_sdk":
            {
                "enable": false,
                "fcm_token": null
            }
        },
        "event_subscription":
        {
            "enable": true,
            "events":
            [
                {
                    "development_event_custom_header": null,
                    "development_webhook_url": "",
                    "event_types":
                    [
                        "meeting.started",
                        "meeting.ended"
                    ],
                    "event_usage": "EVENT_FOR_USER",
                    "production_event_custom_header": null,
                    "production_webhook_url": "",
                    "subscription_id": "subscription_id",
                    "subscription_name": "subscription_name"
                }
            ]
        },
        "in_client_feature":
        {
            "collaborate_mode":
            {
                "enable": false,
                "enable_digital_signage": false,
                "enable_play_together": false,
                "enable_screen_sharing": false,
                "enable_zoom_rooms_controller": false
            },
            "guest_mode":
            {
                "enable": false,
                "enable_test_guest_mode": false
            },
            "in_client_oauth":
            {
                "enable": false
            },
            "zoom_app_api":
            {
                "enable": true,
                "zoom_app_apis":
                [
                    "getSupportedJsApis",
                    "onShareApp"
                ]
            }
        },
        "marketplace_actions": {},
        "production_home_uri": "",
        "products":
        [
            "ZOOM_CHAT",
            "ZOOM_MEETING"
        ],
        "team_chat_subscription":
        {
            "enable": true,
            "enable_support_channel": false,
            "shortcuts":
            [
                {
                    "action_id": "actionCommandId",
                    "action_label": "actionName",
                    "action_types":
                    [
                        "COMPOSE_BOX"
                    ],
                    "action_usage": "DIALOG",
                    "dialog_config":
                    {
                        "size": "S",
                        "title": "www"
                    },
                    "shortcut_id": "shortcut_id"
                }
            ],
            "slash_command":
            {
                "command": "",
                "command_hints":
                [
                    {
                        "description": "12",
                        "usage_hint": "12"
                    },
                    {
                        "description": "23",
                        "usage_hint": "23"
                    }
                ],
                "development_message_url": "",
                "enable_add_to_channel": false,
                "production_message_url": "",
                "sender_type": "zoom",
                "welcome_msg":
                {
                    "body": "body",
                    "title": "title"
                }
            }
        },
        "zoom_client_support":
        {
            "mobile":
            {
                "apple_developer_program_team_id": "",
                "enable": false
            },
            "pwa_client":
            {
                "enable": false
            },
            "zoom_room":
            {
                "enable": true,
                "enable_digital_signage": false,
                "enable_personal_zoom_room": false,
                "enable_shared_zoom_room": true,
                "enable_zoom_rooms_controller": false
            }
        }
    },
    "oauth_information":
    {
        "development_redirect_uri": "",
        "oauth_allow_list":
        [
            "",
            ""
        ],
        "production_redirect_uri": "",
        "scope_description": "scope_description",
        "scopes":
        [
            {
                "optional": false,
                "scope": "zoomapp:inmeeting"
            },
            {
                "optional": false,
                "scope": "user:read:email"
            },
            {
                "optional": false,
                "scope": "meeting:read:meeting"
            },
            {
                "optional": false,
                "scope": "imchat:userapp"
            }
        ],
        "strict_mode": false,
        "subdomain_strict_mode": true,
        "usage": ""
    }
}