Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions locales/en/services/cliq/images/logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions locales/en/services/cliq/images/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
97 changes: 97 additions & 0 deletions locales/en/services/cliq/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
title: "Zoho Cliq Notifications"
description: "Post messages to Zoho Cliq channels and bots using a Webhook Token."
sidebar:
label: "Zoho Cliq"

source: https://www.zoho.com/cliq/

schemas:
- cliq
- zcliq
- zohocliq

has_chat: true
has_image: true

body_formats:
- markdown

limits:
max_chars: 5000

sample_urls:
- cliq://{token}/{channel}
- cliq://{token}/@{bot}
- cliq://{botname}@{token}/#{channel}/@{bot}?region=eu
---

<!-- SPONSORS:BANNER -->
<!-- SERVICE:DETAILS -->

## Account Setup

[Zoho Cliq](https://www.zoho.com/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.

<!-- TEMPLATE:SERVICE-PARAMS -->

## Examples

Send a message to the `general` channel:

```bash
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:

```bash
apprise -vv -t "Disk Space" -b "db01 is at 95% disk usage" \
"cliq://Monitor@1001.2798931fdf4905dc5d37806b47d8253a.2d73063dae2ccf4a04810ddb0a1b2c3d/#ops/@alertbot?region=eu&broadcast=yes"
```
97 changes: 97 additions & 0 deletions locales/fr/services/cliq/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
title: "Notifications Zoho Cliq"
description: "Publiez des messages dans des canaux et des bots Zoho Cliq à l'aide d'un jeton de webhook."
sidebar:
label: "Zoho Cliq"

source: https://www.zoho.com/cliq/

schemas:
- cliq
- zcliq
- zohocliq

has_chat: true
has_image: true

body_formats:
- markdown

limits:
max_chars: 5000

sample_urls:
- cliq://{token}/{channel}
- cliq://{token}/@{bot}
- cliq://{botname}@{token}/#{channel}/@{bot}?region=eu
---

<!-- SPONSORS:BANNER -->
<!-- SERVICE:DETAILS -->

## Configuration du compte

Les messages [Zoho Cliq](https://www.zoho.com/cliq/) sont publiés à l'aide d'un jeton de webhook (Webhook Token) :

1. Connectez-vous à Zoho Cliq et ouvrez **Bots & Tools**, puis **Webhook Tokens**.
2. Terminez l'étape de vérification et cliquez sur **Generate New Token**.
3. Copiez le jeton. Il ressemble à `1001.2798931fdf4905dc5d37806b47d8253a.2d73063dae2ccf4a04810ddb0a1b2c3d`.

Les messages peuvent être envoyés à un canal ou à un bot :

- Les **canaux** sont désignés par leur nom unique, affiché sur la page **Channel Info** du canal.
- Les **bots** sont désignés par leur nom unique précédé d'un `@`. Un message de bot arrive dans votre propre discussion avec le bot, sauf si `broadcast=yes` est défini : dans ce cas, chaque abonné du bot le reçoit.

Si votre compte n'est pas hébergé dans le centre de données américain, ajoutez `region=` à l'URL. L'adresse à laquelle vous vous connectez vous l'indique : par exemple, `cliq.zoho.eu` correspond à `region=eu`.

Vous pouvez aussi coller telle quelle une URL de webhook Cliq, par exemple `https://cliq.zoho.com/api/v2/channelsbyname/{channel}/message?zapikey={token}`.

:::note
Les jetons de webhook permettent uniquement de publier des messages, les pièces jointes ne sont donc pas prises en charge.
:::

## Syntaxe

La syntaxe valide est la suivante :

- `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}`

Les schémas `zcliq://` et `zohocliq://` fonctionnent de la même façon que `cliq://`.

## Détails des paramètres

| Variable | Requis | Description |
| --------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| token | Oui | Votre jeton de webhook Zoho Cliq. |
| channel | \*Non | Le nom unique d'un canal à notifier. Le `#` initial est facultatif. |
| bot | \*Non | Le nom unique d'un bot à notifier, précédé d'un `@`. |
| botname | Non | Le nom d'expéditeur affiché sur le message. S'il n'est pas défini et que `image=yes`, le nom **Apprise** est utilisé. |
| region | Non | Le centre de données qui héberge votre compte. Les valeurs possibles sont **us**, **eu**, **in**, **au**, **cn**, **jp**, **sa**, **uk** et **ca**. La valeur par défaut est **us**. |
| company | Non | L'identifiant de votre entreprise, pour les comptes qui appartiennent à plusieurs entreprises. C'est le numéro qui suit `/company/` dans votre adresse Cliq. |
| image | Non | Affiche comme image de l'expéditeur une icône correspondant au type de notification. Mettez `no` pour publier en votre propre nom. La valeur par défaut est `yes`. |
| broadcast | Non | Envoie les messages de bot à chaque abonné du bot. La valeur par défaut est `no`. |

\*Au moins un canal ou un bot doit être indiqué.

<!-- TEMPLATE:SERVICE-PARAMS -->

## Exemples

Envoyer un message au canal `general` :

```bash
apprise -vv -t "Sauvegarde terminée" -b "Tous les fichiers ont été copiés" \
"cliq://1001.2798931fdf4905dc5d37806b47d8253a.2d73063dae2ccf4a04810ddb0a1b2c3d/general"
```

Envoyer un message à un canal et à chaque abonné d'un bot, pour un compte hébergé en Europe :

```bash
apprise -vv -t "Espace disque" -b "db01 est utilisé à 95 %" \
"cliq://Monitor@1001.2798931fdf4905dc5d37806b47d8253a.2d73063dae2ccf4a04810ddb0a1b2c3d/#ops/@alertbot?region=eu&broadcast=yes"
```
Loading