Update Webhook

Update Webhook

Overview
This API updates an existing outgoing webhook. You can modify its name, description, triggers, and URL. If you change the URL, a validation request (ping trigger) is sent to the new endpoint.
 

API 

PATCH /api/v1/webhook/{id}
 

Oauth Scope

ConnectCommunity.outgoingwebhook.UPDATE
 

Sample request 

  1.  

  2. $curl -X PATCH https://communityspaces.zoho.com/api/v1/webhook

  3. -H "scopeid:5313000000002002"

  4. -H" Authorization:Zoho-oauthtoken        1000.3d0a155402XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

  5. -d '{

  6. "active":"true",

  7. "triggers":[

  8. {

  9. "type":"Task_Assigned"

  10. },

  11. {

  12. "type":"User_Mentioned_In_Post",

  13. "partitionIds":["3000000005135"]

  14. },

  15. {

  16. "type":"Space_Mentioned_In_Post",

  17. "partitionIds":["3000000005135"]

  18. }

  19. ]

  20. }'

 

Sample response 

  1. {

  2. "id":"3000000126027",

  3. "name":"Notify in Cliq",

  4. "active":"true",

  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":"Task_Assigned"

  14. },

  15. {

  16. "type":"User_Mentioned_In_Post",

  17. "partitionIds":["3000000005135"]

  18. },

  19. {

  20. "type":"Space_Mentioned_In_Post"

  21. }

  22. ]

  23. }

 

Sample Error Response

  1. {

  2.     

  3. }