Incoming Webhooks
Overview
Incoming Webhooks are the best way to post messages from different apps to your Zoho Connect Network, so you can stay updated on activities in your other applications without leaving Zoho Connect.Getting started with Incoming Webhooks
Each Webhook has a unique URL to which you send a JSON payload in a defined format (from an another application). Later, this data gets posted in your Zoho Connect Group. This can help you track and stay notified about the activities in your other applications.Key features of Incoming Webhooks
|
Feature
|
Description
|
|
Configuration
|
Incoming Webhooks are available only at the Group level. |
Flexibility |
Any application that can send HTTPS POST request can send messages
using incoming webhooks.
|
|
Markdown
support
|
|
|
Attachments
|
You can add up to 10 files to a Post. The size limit per file is 10 MB
|
Who can use the Incoming Webhook integration?
A member can create a maximum of 20 Webhooks.
How to approve/restrict Incoming Webhook integration?
- Click the plug icon
from the vertical menu in the top-right part of the page.
- In the new page, click Manage from the left menu.
- Navigate to the Incoming Webhook and click the button in the right to approve/restrict.
Once the network admin restricts the integration, members in the Network can neither configure a new Webhook nor use the existing one.
Click the plug icon
from the vertical menu in the top-right part of the page.
Scroll through the list of Integrations and click Incoming Webhook.
Click Configure.
Select the Group, where you would like to post messages.
Enter a name for the Webhook, and upload an image.
Click Save.
The new field that appears below the Custom Function will give you the URL for the Incoming Webhook. Messages from other applications will be sent to this URL, and the URL is also specific to the Group that you have selected.
Copy the Webhook URL to the clipboard and save it.
How to post a status using an Incoming Webhook?
Content-type: application/x-www-form-urlencoded
payload-{"message":"<b>Service Request</b> <br><br> Your service request has been approved.Kindly contact your administrator to proceed further"}
Response codes for a Post made using an Incoming Webhook
- {"status":"success","id":"unique id of post/comment created"}
- {"status":"failure","errorCode": "EXTRA_KEY_FOUND","reason":"Extra key found in the JSON parameter payload"}
Custom Function in Incoming Webhooks
Click integrations from the vertical menu in the top-right part of the page.
Scroll through the list of Integrations and click Incoming Webhook.
Click Configure to create a new Incoming Webhook, or open an existing one.
Navigate to Custom Function, click Write function.
In the pop-out editor, write your code.
Once done, close the editor and click Save.
- params - Map (Key Value pair of all the parameters sent with the request)
- headers - Map (Key Value pair of all the headers of the request)
- body - String (content written in the body of the request)
- network - Map(Key Value pair of details about the current network)
- { "createdBy":{"name":"mark","emailId":"mark@zillum.com", "id":"142283" }, "domian":"zillum.com", "name":"zillum Network", "id":"22000000002002", "type":"2", // 2 for intranet , 4 for extranet "plan":"2",//0 for free, 1 for trial and 2 for enterprise "url":"https://connect.zoho.com/portal/intranet" }
Response codes for a Custom Function
- { "customFunctionResponse": {"message": {"userMessage": []},"output": {"payload":{"message": "Testing Content","linkUrl": "https://connect.zoho.com/portal/intranet"}},"status": "success"},
"status": "success",
"id": "3000000577088" }
{ "customFunctionResponse": {"message": {"userMessage": []},"output": {"payload":{"message": "Testing Content","value":"Content for test"},"streamId":"3000000577088","messageType":"comment"},"status": "success"},
" status ": "failure",
" errorCode ": "1044",
"reason ": "Extra key found in the JSON value" }
{ "customFunctionResponse": {"status": "failure"},
" status ": "failure",
" errorCode ": "1045",
" reason ": "Unable to execute custom function" }
How to protect your Webhook URL?
Click Integrations from the vertical menu in the top-right part of the page.
Navigate to Incoming Webhook.
Open the required Webhook, navigate to Webhook URL.
Click Re-generate, seen in the bottom-right of the URL box.
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
Zoho Sheet Resources
Zoho Forms Resources
Zoho Sign Resources
Sign, Paperless!
Zoho TeamInbox Resources
Zoho DataPrep Resources
Design. Discuss. Deliver.
Related Articles
Message formats in Incoming Webhooks
Overview This document will help you with a few basic message formatting options in Incoming Webhooks, required parameters, the input data, and how to implement it. Click here to learn about the basics of Incoming Webhooks. What are the parameters ...Advanced message formatting options in Incoming Webhooks
Overview You can keep your Posts simple as a single line of text, or present the information in a distinguished manner with the help of the advanced formatting options. In the advanced formatting option, the JSON payload that you send to the Webhook ...An example for Function API
Let us consider an example in which a new task is created in Zoho Connect whenever a ticket is added in Zoho Desk. This is implemented using an Outgoing Webhook in Zoho Desk that will make a POST request to an API endpoint in Zoho Connect. But Desk's ...Prerequisites for adding comments, posts, and tasks through email
Overview Zoho Connect enables you to add comments, posts, and tasks in your network from your email. If your organization uses a custom email domain that contains your business' domain (example: user@zylker.com), the organization admin must configure ...Working with Custom Apps
Who can create a Custom App? Depending on the permissions set by the admin, members might or may not be able to create a Custom App in the Group or Company Wall. How do I create a Custom App? Click Custom Apps from the main menu on the left. Click ...