概要
送信Webhookを使用すると、指定したイベントが発生した際に、Zoho CommunitySpacesから外部アプリケーションにイベント情報を送信できます。
送信Webhook APIを使用すると、Zoho CommunitySpacesのコミュニティ内の送信Webhookをプログラムで作成、取得、更新、削除できます。
Webhookの作成時には、エンドポイントURLと、Webhookを実行するきっかけとなるイベントを指定します。指定したイベントのいずれかが発生すると、Zoho CommunitySpacesは、設定されたエンドポイントに該当するイベント情報を送信します。
|
名前 |
データ型 |
説明 |
要件 |
|
id |
Long |
Webhookの一意のID |
読み取り専用 |
|
name |
String(50) |
Webhookの名前 |
必須 |
|
description |
String (250) |
Webhookの説明 |
任意 |
|
url |
String (500) |
イベント情報の送信先となるサーバーのエンドポイント |
必須 |
|
active |
Boolean 初期値:true |
Webhookが有効かどうかを返すキー。 |
任意 |
|
createdBy |
Long |
Webhookを作成したユーザーのID |
読み取り専用 |
|
createdTime |
Long |
Webhookの作成日時。 |
読み取り専用 |
|
autoRetry |
Boolean 初期値:false |
自動再試行オプションが有効かどうかを返すキー |
任意 |
|
triggers |
JSONArray |
Webhookの処理を実行するトリガーの配列 |
必須 |
|
名前 |
データ型 |
説明 |
必須/任意 |
|
type |
文字列 |
Webhookトリガーの一意のキー |
必須 |
|
partitionIds |
partitionIdsのJSON配列 |
トリガーとなる操作が実行されたConnectエンティティのID。
|
任意 |
たとえば、typeはWebhookを起動するイベントを指定し、partitionIdsはトリガーの対象を特定のエンティティに限定するために使用できます。
Webhookの取得- Zoho CommunitySpacesのコミュニティから、特定の送信Webhookの詳細を取得します。
Webhookの作成- Zoho CommunitySpacesのコミュニティに送信Webhookを作成します。
Webhookの更新- 既存の送信Webhookの名前、説明、トリガー、URLなどの詳細を更新します。
Webhookの削除- Zoho CommunitySpacesのコミュニティから既存の送信Webhookを削除します。