Webhookの作成

Webhookの作成

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

概要
このAPIは、Zoho CommunitySpacesのコミュニティに送信Webhookを作成します。APIを呼び出すと、指定したエンドポイントURLに検証要求(pingトリガー)が送信されます。検証を完了してWebhookを作成するには、エンドポイントが200 OKレスポンスを返す必要があります。200 OKレスポンスが返されない場合、Webhookは作成されません。
 

API

POST /api/v1/webhook
 

OAuthスコープ

ConnectCommunity.outgoingwebhook.CREATE
 

要求の例

  1. $curl -X POST https://communityspaces.zoho.com/api/v1/webhook
  2. -H 'scopeid:5313000000002002'
  3. -H' Authorization:Zoho-oauthtoken 1000.3d0a155402XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
  4. -d '{
  5. 'name':'Cliqで通知',
  6. 'active':'false',
  7. 'autoRetry':'true',
  8. 'description':'コミュニティの重要な活動をZoho Cliqのチャンネルで通知',
  9. 'triggers':[
  10. {
  11. 'type':'Board_Created'
  12. },
  13. {
  14. 'type':'Task_Assigned'
  15. },
  16. {
  17. 'type':'User_Mentioned_In_Post',
  18. 'partitionIds':['3000000005135']
  19. },
  20. {
  21. 'type':'Space_Mentioned_In_Post',
  22. 'partitionIds':['3000000005135']
  23. }
  24. ],
  25. 'url':'https://cliq.zoho.com/api/v2/channelsbyname/zo
  26. hocommunityspaces/message'
  27. }'
 

レスポンスの例 

  1. {
  2. 'id': '3000000126027',
  3. 'name': 'Cliqで通知',
  4. 'active': 'false',
  5. 'autoRetry': 'true',
  6. 'createdTime': '1635755951141',
  7. 'createdBy': '15521849',
  8. 'description': 'コミュニティの重要な活動をZoho Cliqのチャンネルで通知',
  9. 'url':'https://cliq.zoho.com/api/v2/channelsbyname/zo
  10. hocommunityspaces/message',
  11.   'triggers':[
  12. {
  13. 'type': 'Board_Created'
  14. },
  15. {
  16. 'type': 'Task_Assigned'
  17.   },
  18. {
  19. 'type': 'User_Mentioned_In_Post',
  20. 'partitionIds':['3000000005135']
  21. },
  22.      {
  23.        'type': 'Space_Mentioned_In_Post',
  24. 'partitionIds': ['3000000005135']
  25.      }
  26.    ]
  27. }
 
送信Webhookについてご不明な点がある場合は、support@zohocommunityspaces.comまでお問い合わせください。