ZCatalyst Cliq SDK

The official python sdk for integrating Zoho Catalyst with Zoho Cliq.

ZCatalyst Cliq SDK helps you to work with Python for handling Zoho Cliq extensions using Zoho Catalyst.

Prerequisites

To start working with this SDK you need to sign up with catalyst and cliq

Then you need to install suitable version of Python and pip

Installing

The ZCatalyst Cliq SDK is a pip package and can be found as zcatalyst-cliq on PyPI:

python -m pip install zcatalyst-cliq

Using zcatalyst-cliq

After installing zcatalyst-cliq, you can initialize it in your catalyst's cliq integration functions as:

import zcatalyst_cliq

# your cliq handler files's mapping should be given here
config = {
    "ZohoCliq": {
        "handlers": {
            "bot_handler": "handlers/bot_handler.py",
            "function_handler": "handlers/function_handler.py",
            "command_handler": "handlers/command_handler.py",
            "widget_handler": "handlers/widget_handler.py",
            "messageaction_handler": "handlers/message_action_handler.py",
            "extension_handler": "handlers/extension_handler.py",
            "link_preview_handler": "handlers/link_preview_handler.py"
        }
    },
}

def handler(request, response):
    handler_resp = zcatalyst_cliq.execute(request, config)
    response.set_content_type('application/json')
    response.send(handler_resp)

Documentation

For documentation and further queries kindly contanct support@zohocatalyst.com