Message formats in Incoming Webhooks

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 supported?

Payload* - JSON
messageType - status/event/comment (default value is status)
streamId - long
commentId - Long
attachment - file

The parameter/JSON keys with a * next to them are mandatory ones.

Ensure that the request is in "application/x-www-form-urlencoded" format. If not, an error message will be generated.

Markdown help

The contents of the key "message" supports basic HTML markdown:
  1. Bold - *content*
  2. Italics - _content_
  3. strike - ~content~
  4. underline - +content+
  5. anchor - [content](link)
  6. BlockQuote - !content
  7. highlight - `content` 

How to post a status using Incoming Webhooks?

To post a simple message using an Incoming webhook, set the payload parameter with following JSON keys:

JSON key
 Data type/Required format
    Description


message*
 String
 The message that has to be displayed
title
 String
 Post title

Example: 
  1. POST https://connect.zoho.com/webhook/v1/incoming/intranet/499400157703126?zapikey=XXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

    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."}

The message posted in the Group will be as follows:

      

How to post a message with a URL using Incoming Webhooks?

To post a message with an URL in it, set the payload parameter with following JSON keys:

JSON key
    Data type/Required format
 Description


message*
 String
 The message that has to be displayed
title
 String
 Post title
linkUrl
 URL
 Link to the data source

Example: 
  1. POST https://connect.zoho.com/webhook/v1/incoming/intranet/499400157703126?zapikey=XXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

    Content-type: application/x-www-form-urlencoded

    Parameters:

    payload={"title":"New Feature","message":"Learn more about how adding the Zoho Projects integration in Connect can help you increase your productivity.","linkUrl":"https://www.youtube.com/watch?v=FfsDMdZIg4s"}


The message posted in the Group will be as follows:

      

How to post an event details using Incoming Webhooks?

To post an event using an Incoming Webhook, set the  payload parameter with following JSON keys:

JSON key
 Data type/Required format
    Description


eventTitle*

String

  Title of the event

eventDesc

String

 A brief d escription of the event

eventLocation

String

  Location of the Event

startDate*

YYYY-MM-DD, HH:MM

 Start date of the event

endDate

YYYY-MM-DD, HH:MM
 E nd date of the event 

allDay

boolean

 This can be used if the event is scheduled for the     entire day

You'll need to set the parameter messageType as event. If not, it will be considered as status by default.

Example:
  1. POST https://connect.zoho.com/webhook/v1/incoming/intranet/499400157703126?zapikey=XXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

    Content-type: application/x-www-form-urlencoded

    Parameters:

    payload {"eventTitle":"zoholics","eventDesc":"Tech event conducted between zoho developers and customers","eventLocation":"Bangalore","startDate":"2020-05-11 10:00","endDate":"2020-06-11 18:00"}

    message Type=event

The message posted in the Group will be as follows:
      
      
      
If it's an all day event include the JSON key and value  "allDay" : "true".

How to add a Comment using Incoming Webhook?

To post a comment using an Incoming Webhook, set the following JSON keys in payload paramter:

Parameter
Data type/Required format
 Description 

payload
JSON
Message in JSON format

messageType*

Comment

Message type of the Post. 

streamId*

String

Unique Id of the Feeds.

commentId

String

Unique Id of the comment to which reply comment should be added (in case you're replying to a comment).


  1. POST https://connect.zoho.com/webhook/v1/incoming/intranet/499400157703126?zapikey=XXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

    Content-type: application/x-www-form-urlencoded

    Parameters:

    payload={"message":" your request has been assigned to @Micheal@test.com"}

    messageType=comment

    streamId = 10500041******

How to mention a user in a Post?

To mention a user, use @ before their email address.
Example
  1. payload = {" message":" @zillum@zylker.com Please check the book cover and share your thoughts on it."," title","New book launch"}.

How to add a Tag?

Enter # before the word you would like to tag.

Example:
  1. payload = {"message":"The brochure for our book launch has finally arrived! #new launch"," title","New book launch"}.

Click here to know about the advanced formatting options in Incoming Webhooks like adding tables, embedding images, and a lot more.


      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        Access your files securely from anywhere

          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 CRM Training
            Redefine the way you work
            with Zoho Workplace

              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 CRM Training

                Create, share, and deliver

                beautiful slides from anywhere.

                Get Started Now


                  Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                  BOOK A SESSION







                              Quick LinksWorkflow AutomationData Collection
                              Web FormsRetailOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceForms for Solopreneurs
                              Digital FormsMarketingForms for Small Business
                              HTML FormsEducationForms for Enterprise
                              Contact FormsE-commerceForms for any business
                              Lead Generation FormsHealthcareForms for Startups
                              Wordpress FormsCustomer onboardingForms for Small Business
                              No Code FormsConstructionRSVP tool for holidays
                              Free FormsTravelFeatures for Order Forms
                              Prefill FormsNon-Profit
                              Forms for Government
                              Intake FormsLegal
                              Mobile App
                              Form DesignerHR
                              Mobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic FormsInsurance
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsWufoo alternativeEncrypted Forms
                              Accessible FormsTypeform alternativeSecure Forms

                              WCAG

                                          Create. Review. Publish.

                                          Write, edit, collaborate on, and publish documents to different content management platforms.

                                          Get Started Now






                                                            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.




                                                                Manage your brands on social media

                                                                  Use cases

                                                                  Make the most of Zoho Desk with the use cases.

                                                                   
                                                                    

                                                                  eBooks

                                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho Desk.

                                                                   
                                                                    

                                                                  Videos

                                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho Desk.

                                                                   
                                                                    

                                                                  Webinar

                                                                  Sign up for our webinars and learn the Zoho Desk basics, from customization to automation and more

                                                                   
                                                                    
                                                                  • Desk Community Learning Series


                                                                  • Meetups


                                                                  • Ask the Experts


                                                                  • Kbase


                                                                  • Resources


                                                                  • Glossary


                                                                  • Desk Marketplace


                                                                  • MVP Corner



                                                                    Zoho Sheet Resources

                                                                     

                                                                        Zoho Forms Resources


                                                                          Secure your business
                                                                          communication with Zoho Mail


                                                                          Mail on the move with
                                                                          Zoho Mail mobile application

                                                                            Stay on top of your schedule
                                                                            at all times


                                                                            Carry your calendar with you
                                                                            Anytime, anywhere




                                                                                  Zoho Sign Resources

                                                                                    Sign, Paperless!

                                                                                    Sign and send business documents on the go!

                                                                                    Get Started Now




                                                                                            Zoho TeamInbox Resources





                                                                                                      Zoho DataPrep Demo

                                                                                                      Get a personalized demo or POC

                                                                                                      REGISTER NOW


                                                                                                        Design. Discuss. Deliver.

                                                                                                        Create visually engaging stories with Zoho Show.

                                                                                                        Get Started Now









                                                                                                                            • Related Articles

                                                                                                                            • Incoming Webhooks

                                                                                                                              Feature Availability 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 ...
                                                                                                                            • 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 ...
                                                                                                                            • Managing outgoing webhooks

                                                                                                                              Overview An outgoing webhook lets you send real-time updates from Zoho Connect to third-party apps. You can choose which activities trigger these updates. Who can configure? By default, only network admins can set up outgoing webhooks. Admins can ...
                                                                                                                            • Files upload and download policy

                                                                                                                              Feature Availability Overview This policy in Zoho Connect allows network admins to manage how users upload, share, and access files within the network. These settings help ensure secure file sharing and align with your organization’s data policies. ...
                                                                                                                            • 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 ...
                                                                                                                              Wherever you are is as good as
                                                                                                                              your workplace

                                                                                                                                Resources

                                                                                                                                Videos

                                                                                                                                Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                                eBooks

                                                                                                                                Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                                Webinars

                                                                                                                                Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                                CRM Tips

                                                                                                                                Make the most of Zoho CRM with these useful tips.



                                                                                                                                  Zoho Show Resources