Zoho Cliq Notifications

Overview

• Source: https://www.zoho.com/cliq/
• Image Support: Yes
• Attachment Support: No
• Message Character Limits:
  • Body: 5000
• Supported Body Format(s):
  • ✓MARKDOWN
• Build Your Apprise URL

Account Setup

Zoho Cliq messages are posted using a Webhook Token:

1. Sign in to Zoho Cliq and open Bots & Tools, then Webhook Tokens.
2. Complete the verification step and click Generate New Token.
3. Copy the token. It looks like 1001.2798931fdf4905dc5d37806b47d8253a.2d73063dae2ccf4a04810ddb0a1b2c3d.

Messages can be sent to a channel or to a bot:

• Channels are addressed by their unique name, which is shown on the channel’s Channel Info page.
• Bots are addressed by their unique name with a leading @. A bot message goes to your own chat with the bot unless broadcast=yes is set, in which case every subscriber of the bot receives it.

If your account is not hosted in the US data center, add region= to the URL. You can tell which one you use from the address you sign in at, for example cliq.zoho.eu means region=eu.

You can also paste a Cliq webhook URL as-is, for example https://cliq.zoho.com/api/v2/channelsbyname/{channel}/message?zapikey={token}.

Note

Webhook Tokens can only post messages, so attachments are not supported.

Syntax

Valid syntax is as follows:

• cliq://{token}/{channel}
• cliq://{token}/#{channel}
• cliq://{token}/@{bot}
• cliq://{botname}@{token}/#{channel1}/#{channel2}/@{bot}
• https://cliq.zoho.com/api/v2/channelsbyname/{channel}/message?zapikey={token}
• https://cliq.zoho.com/api/v2/bots/{bot}/message?zapikey={token}

The zcliq:// and zohocliq:// schemas work the same way as cliq://.

Parameter Breakdown

Variable	Required	Description
token	Yes	Your Zoho Cliq Webhook Token.
channel	*No	The unique name of a channel to notify. The leading # is optional.
bot	*No	The unique name of a bot to notify, written with a leading @.
botname	No	The sender name shown on the message. When it is not set and image=yes, the name Apprise is used.
region	No	The data center your account is hosted in. Possible values are us, eu, in, au, cn, jp, sa, uk and ca. The default is us.
company	No	Your company ID, for accounts that belong to more than one company. It is the number after /company/ in your Cliq address.
image	No	Shows an icon that matches the notification type as the sender’s picture. Set it to no to post as yourself instead. The default is yes.
broadcast	No	Sends bot messages to every subscriber of the bot. The default is no.

*At least one channel or bot must be specified.

Global Parameters

Variable	Description
overflow	Controls messages that exceed a service’s documented limit. The default is upstream. 👉 upstream: Send one message without splitting or truncating it for that limit. 👉 truncate: Keep the portion that fits and discard the rest. 👉 split: Prefer a readable break, fall back to a hard boundary, and send every part in order. Splitting undeclared or structured content is best effort. Use upstream when the body must remain one intact document.
format	This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verify	External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes.
redirect	By default, Apprise will follow HTTP redirects (3xx responses) issued by the remote server, matching the behaviour of the underlying requests library. If you want to prevent custom headers and credentials from being forwarded to destinations that differ from the original URL, set this to no. By default it is set to yes.
cto	This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rto	This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojis	Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tz	Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area.
retry	The number of additional delivery attempts to make after the first failure before giving up. Accepts an integer in the range 0 to 10. The default is 0 (no retries – a single attempt is made). When combined with wait, Apprise pauses the specified number of seconds between each attempt.
wait	The number of seconds to pause between retry attempts. Accepts a decimal value in the range 0.0 to 20.0; integer values are promoted to float automatically. The default is 0.5. This value is only meaningful when retry is greater than zero – a service with retry=0 makes exactly one attempt regardless of the wait value.
optional	When set to yes, a delivery failure for this service is silently absorbed. The overall notify() call still evaluates as true even if this endpoint was unreachable, provided that every required (non-optional) service in the same batch succeeded. Setting this flag does not skip delivery or bypass retry logic – all configured retry attempts are still made before the failure is absorbed. By default this is set to no, meaning every failure is propagated to the caller.

Examples

Send a message to the general channel:

apprise -vv -t "Backup Complete" -b "All files were copied" \
   "cliq://1001.2798931fdf4905dc5d37806b47d8253a.2d73063dae2ccf4a04810ddb0a1b2c3d/general"

Send a message to a channel and to every subscriber of a bot, on an account hosted in Europe:

apprise -vv -t "Disk Space" -b "db01 is at 95% disk usage" \
   "cliq://Monitor@1001.2798931fdf4905dc5d37806b47d8253a.2d73063dae2ccf4a04810ddb0a1b2c3d/#ops/@alertbot?region=eu&broadcast=yes"