コミュニティでの受信Webhookの設定

コミュニティでの受信Webhookの設定

お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

受信Webhookの概要  

受信Webhookを使用すると、固有のWebhook URLにJSONペイロードを送信することで、他のアプリケーションからZoho CommunitySpacesに更新情報を送信できます。ここで説明する構成では、Webhookはスペース単位で利用でき、HTTPS POST要求に対応しています。メッセージには基本的なHTMLマークダウンを使用でき、投稿ごとに最大10件のファイルを添付できます。各ファイルの上限サイズは10MBです。

ご利用のプランで作成できるWebhookの数と実行回数の上限は、以下の表をご確認ください。

プラン

Webhook数

実行回数の上限

Lite

0

0

Standard

10

100

Growth

20

500

Premium

50

1,000

 

受信Webhookの設定  

  1. 右側のメニューにある歯車アイコンをクリックします。



  2. [受信Webhook]を、[自動化]内でクリックします。



  3. [設定]をクリックします。



  4. Webhookでメッセージを投稿するスペースまたはボードを選択します。



  5. [名前]項目に名前を入力し、必要に応じて画像をアップロードします。

  6. 必要に応じて説明を追加し、[保存]をクリックします。



情報Webhookを保存すると、[Webhook URL]セクションに固有のWebhook URLが自動生成されます。他のアプリケーションから選択したスペースに投稿する際に使用するため、このURLをコピーして安全に保管してください。


シンプルなメッセージの投稿  

受信Webhookでは、application/x-www-form-urlencodedまたはmultipart/form-dataを使用する必要があります。以下の例は、参照元の記事に記載されている要求の構造に従い、ドメインをCommunitySpaces用に変更したものです。

 curl --request POST \
--url 'url got from the configuration' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'payload={'message':'<b>Service Request</b><br><br>Your community request has been approved. Kindly contact your host to proceed further.'}'

要求が有効な場合、設定したスペースにメッセージが投稿されます。

 

レスポンスコードの概要  

Webhookへの投稿が成功すると、サービスはHTTP 200とともに、成功ステータスと作成された項目のIDを返します。要求の検証に失敗すると、HTTP 400とともに、失敗ステータス、エラーコード、失敗の理由を返します。

成功時のレスポンス:

{'status':'success','id':'<post_or_comment_id>'}

Failure response:

{'status':'failure','errorCode':'EXTRA_KEY_FOUND','reason':'Extra key found in the JSON parameter payload'}

 

カスタム関数の使用  

送信元のアプリケーションが、あらかじめ定義されたWebhook形式でデータを送信できない場合は、カスタム関数を使用します。この関数は、受信した要求をWebhook形式に変換し、返されたマップがWebhookの入力になります。カスタム関数は、スーパーホストまたはホストによる認証が必要です。実行時には、params、headers、body、communityの4つの入力を受け取ります。

 

カスタム関数を追加するには:

  1. 右側のメニューの歯車アイコンをクリックします。



  2. [受信Webhook]を、[自動化]内でクリックします。



  3. 表示されたページで、新しいWebhookを作成するか、既存のWebhookを開きます。

  4. [ハンドラー]を、Webhook設定ページで開き、展開ボタンをクリックします。



  5. [関数を記述]をクリックします。



  6. コードをエディターに入力します。



  7. エディターを閉じて、[保存]をクリックします。

カスタム関数の実行結果は、大きく分けて「すべて成功」「関数は成功したが投稿は失敗」「関数の実行に失敗」の3つです。


Webhook URLの保護と再生成  

Webhook URLを知っている人は誰でも投稿できるため、URLを公開しないでください。URLが漏えいした可能性がある場合は、すぐに再生成してください。

  1. 右側のメニューの歯車アイコンをクリックします。



  2. [受信Webhook]を、[自動化]内でクリックします。



  3. 更新するWebhookを開き、ポップアップで[設定を編集]をクリックします。



  4. [Webhook URL]セクションに移動します。



  5. [再生成]を、URL欄の右下でクリックします。


同じ設定編集ページで、必要に応じてWebhook URLを複製したり削除したりすることもできます。



 受信Webhookのログの確認 

スーパーホストまたはホストは、受信Webhookのログを表示し、要求を追跡して正常に実行されたかどうかを確認できます。要求が失敗した場合は、ログの詳細を確認して原因を特定し、問題を解決してください。

見積書関連記事:
  1. Zoho CommunitySpacesの受信Webhookで基本的な形式のメッセージを送信する方法  
  2. Zoho CommunitySpacesの受信Webhookで高度なメッセージ書式を使用する方法

ご質問やフィードバックは、support@zohocommunityspaces.comまでお寄せください。