ボットをIncoming Webhookノーティファイアとして設定する

次に、GitHub上でwebhook URLが呼び出された際にアクションを実行する、Incoming Webhookノーティファイアとしてボットを設定しましょう。以下の手順で行います。

1. Cliqボット上でwebhookトークンを生成する
2. エクステンションのApp Keyを取得する
3. エクステンションのwebhookハンドラーURLを取得する
4. GitHub上でwebhookを作成し、これらの値を設定する

これらのアクションについて、順を追って詳しく説明します。

このwebhookは、Gitアカウントのリポジトリにコミットがプッシュされるたびにトリガーされます。そのイベントが発生すると、GitHubは設定した認証情報とともにwebhookハンドラーURLへHTTPリクエストを送信します。プッシュイベントの詳細がCliqに渡され、Cliqボットがその詳細を通知・表示します。

WebHookトークンの生成

以下の手順でCliq上でwebhookトークンを生成できます。webhookトークンは、前のステップで設定したauthenticateボタンファンクションによって認証されます。

1. CliqアカウントでGitHub Botを検索します。ボットを選択し、Continueをクリックします。

2. ボットがアカウント情報にアクセスすることを許可します。
   チャットが有効になります。

3. チャットで「webhooktoken」と入力し、Enterキーを押します。

4. Create Webhookボタンをクリックします。

5. エクステンションが認証トークンにアクセスすることを許可します。

6. ボットがwebhookトークンを生成して表示します。このトークンをコピーしてください。 このwebhookトークンは、GitHub上で設定するURLのzapikeyパラメータの値になります。

App Keyの取得

以下の手順でエクステンションのApp Keyを取得できます。

1. Cliq開発者コンソールのエクステンションページでGitHubExtエクステンションをクリックし、Connectorsセクションに移動します。

2. エクステンションのSandbox App Keyをコピーします。
   
   このキーは、GitHub上で設定するURLのappkeyパラメータの値になります。

WebhookハンドラーURLの取得

以下の手順でエクステンションのWebhookハンドラーURLを取得できます。

1. Cliqアカウントに戻り、プロフィール画像をクリックします。メニューセクションのBots & Toolsをクリックします。
   

2. ボット一覧からGitHub Botをクリックします。サイドパネルが開きます。_Incoming WebHook Endpoint_の下に表示されるURLをコピーします。
   
   

これがGitHub上で設定するベースURLになります。

GitHub上でWebhookを作成する

GitHub上で設定する完全なURLは以下のとおりです。

baseURL?appkey={{appkey}}&zapikey={{zapikey}}

_baseURL_はwebhookハンドラーURL、appkeyはエクステンションのSandbox App Key、zapikeyはCliq上で生成したwebhookトークンです。

例：

https://cliq.zoho.com/company/org_id/api/v2/githubbot/incoming?appkey={{appkey}}&zapikey={{zapikey}}

以下の手順でこのURLをGitHubに追加しましょう。

1. GitHubアカウントを開き、リポジトリのいずれか1つに移動します。

2. リポジトリの設定を開き、Webhooks -> Add webhookをクリックします。

3. 上記の形式でURLを入力し、appkeyとzapikeyの値を代入します。以下のようにwebhookを設定します。 通知を受け取りたいイベントを選択できます。

4. Add webhookをクリックします。

このwebhookにより、リポジトリの設定されたイベントに対するアラートが有効になります。