Create Webhook

Create Webhook

Overview
This API creates an outgoing webhook in your Zoho CommunitySpaces community. When you invoke the API, a validation request (ping trigger) is sent to the specified endpoint URL. The endpoint must return a 200 OK response to validate and create the webhook. If it does not return a 200 OK response, the webhook will not be created.
 

API

POST /api/v1/webhook
 

Oauth Scope

ConnectCommunity.outgoingwebhook.CREATE
 

Sample request

  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":"Notify in Cliq",
  6. "active":"false",
  7. "autoRetry":"true",
  8. "description":"Notify important Community activities in a Zoho Cliq Channel",
  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. }'
 

Sample response 

  1. {
  2. "id": "3000000126027",
  3. "name": "Notify in Cliq",
  4. "active": "false",
  5. "autoRetry": "true",
  6. "createdTime": "1635755951141",
  7. "createdBy": "15521849",
  8. "description": "Notify important Community activities in Zoho Cliq Channel",
  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. }
 
 If you have any queries with outgoing webhooks, reach out to our team at support@zohocommunityspaces.com.