概要
このAPIは、Zoho CommunitySpacesのコミュニティに送信Webhookを作成します。APIを呼び出すと、指定したエンドポイントURLに検証要求(pingトリガー)が送信されます。検証を完了してWebhookを作成するには、エンドポイントが200 OKレスポンスを返す必要があります。200 OKレスポンスが返されない場合、Webhookは作成されません。
API
POST /api/v1/webhook
OAuthスコープ
ConnectCommunity.outgoingwebhook.CREATE
要求の例
- $curl -X POST https://communityspaces.zoho.com/api/v1/webhook
- -H 'scopeid:5313000000002002'
- -H' Authorization:Zoho-oauthtoken 1000.3d0a155402XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
- -d '{
- 'name':'Cliqで通知',
- 'active':'false',
- 'autoRetry':'true',
- 'description':'コミュニティの重要な活動をZoho Cliqのチャンネルで通知',
- 'triggers':[
- {
- 'type':'Board_Created'
- },
- {
- 'type':'Task_Assigned'
- },
- {
- 'type':'User_Mentioned_In_Post',
- 'partitionIds':['3000000005135']
- },
- {
- 'type':'Space_Mentioned_In_Post',
- 'partitionIds':['3000000005135']
- }
- ],
- 'url':'https://cliq.zoho.com/api/v2/channelsbyname/zo
- hocommunityspaces/message'
- }'
レスポンスの例
- {
- 'id': '3000000126027',
- 'name': 'Cliqで通知',
- 'active': 'false',
- 'autoRetry': 'true',
- 'createdTime': '1635755951141',
- 'createdBy': '15521849',
- 'description': 'コミュニティの重要な活動をZoho Cliqのチャンネルで通知',
- 'url':'https://cliq.zoho.com/api/v2/channelsbyname/zo
- hocommunityspaces/message',
- 'triggers':[
- {
- 'type': 'Board_Created'
- },
- {
- 'type': 'Task_Assigned'
- },
- {
- 'type': 'User_Mentioned_In_Post',
- 'partitionIds':['3000000005135']
- },
- {
- 'type': 'Space_Mentioned_In_Post',
- 'partitionIds': ['3000000005135']
- }
- ]
- }