Cliq Bots - Get notifications about any action on an application with the incoming webhook handler!

Cliq Bots - Get notifications about any action on an application with the incoming webhook handler!

Webhooks can be used to get notified about events happening in other applications inside Cliq. All bots in Cliq have their own incoming webhook endpoint. This makes it simple to post messages to the bot from external applications. Unlike the send message (/message) REST API, here any data can be posted to the endpoint which is further processed in the incoming handler before notifying in Cliq.

The incoming webhook allows third-party applications to send notifications/alerts using the incoming webhook URL. These responses mostly received as a JSON can be then customized using Cliq's message card templates. The incoming webhook URL of the bot should be configured with the application's outgoing webhook. 

Incoming webhook handler workflow 

The bot's incoming webhook URL will receive the request response from the third party application's URL. The response of the request will be obtained in the body attribute. Take a look at all the attributes passed when a bot's incoming webhook handler is executed in our help page

A pictorial comparison between how Rest APIs and incoming webhooks work is shown below!
Now that we've got the concept of webhooks cleared, let's start off by creating a simple bot's webhook handler. Take a look at the sample scenario given below.

Sample Scenario 

Your support team uses Zendesk to take care of customer queries and keep track of tickets. The team also uses Cliq for internal team communication. So how can you make sure all support reps are notified in Cliq when a new ticket with a high priority has been created? Here's what you can do - create a Support Bot! 

Before we start, this is an integration by parts. Which means that you have to configure the webhook in Zendesk and format your response in Cliq. 

Cliq's part in the integration:  

Creating a bot in Cliq is just a three-step process. All you've to do is, 
  1. Click ' Settings ' in Cliq's top nav bar. 
  2. Select ' Integrations '.
  3. Once you're on the Integrations page, click ' Create Bot ' and give your bot a name, description, status, access level and image! 
Now, to set up the incoming webhook handler of your bot :
  1. Saving the bot will take you to the ' Edit Handlers ' page. Or you can navigate to the edit handlers page from the bot's preview.
  2. Click ' Edit Code ' under the bot incoming webhook handler. 
  3. Write your code in the deluge editor (once you set up the JSON body in Zendesk), click save and done! Take a look at the sample code snippet given below:
  1. // Incoming Webhook Handler Code Snippet 
  2. response = Map();
  3. title = body.get("title");
  4. priority = body.get("priority");
  5. description = body.get("description");
  6. url = body.get("url");
  7. id = body.get("id");
  8. status = body.get("status");
  9. assignee = body.get("assigned_to");
  10. response = {"text": "A new ticket has been created. The ticket details are given below: \n Ticket Name: " + title + " \n Description:" +description+   "\n Priority: `" + priority+ "` \n Ticket ID:" +id+ "\n [Ticket URL](https://" +url+ ") \n Status: " +status+ " \n Assigned To: " +assignee };
  11. return response;
To be done in Zendesk

Create a Target: 
  1. Create an extension. To do so, click 'Extensions' under 'Settings' 
  2. Click 'Add Target' under the targets tab. 
  3. Click 'HTTP target' and give a name, URL, method. 
  4. Give your bot's incoming webhook URL along with the zapikey parameter. Take a look at how to create a zapikey  here
  5. Set your HTTP method as POST. 
  6. Select 'Create Target' and click Submit. 
Sample Bot Incoming Webhook URL:

That's it! Your extension has been created.

Create a Trigger:

The next action is to create a trigger. Triggers are automated rules that work based on predefined conditions. 
  1. Navigate to the Triggers tab and click ' Add Trigger '
  2. Give the trigger a name, description and set a condition. Take a look at the sample condition used for the example shown below. 
  3. Under Actions, select ' Notify Target ' and select your target name. 
  4. The JSON body will contain the ticket details. Modify this to suit your team's requirements. Here's a sample code snippet for the JSON body.
  5. Click Save! 
Sample Trigger Code Snippet:

  1. {"title":"{{ticket.title}}", 
  2. "description" : "{{ticket.description}}", 
  3. "priority":"{{ticket.priority}}",
  4. "url": "{{ticket.url}}",
  5. "id":"{{ticket.id}}",
  6. "status":"{{ticket.status}}",
  7. "assigned_to":"{{ticket.assignee.name}}"
  8. }
Now creating a ticket with a priority set as Urgent  will notify all the support reps in Cliq via the Support Bot!

Take a look at how the Zendesk Ticket will be notified in Cliq via the Support Bot : 

Ticket in Zendesk 




Support Bot notifying in Cliq



And that's how easy it is to configure a bot's incoming webhook handler. Comments and suggestions are welcome. 

Few useful links:




Best,
Manasa
Cliq




    Access your files securely from anywhere


            Zoho Developer Community





                                      • Desk Community Learning Series


                                      • Digest


                                      • Functions


                                      • Meetups


                                      • Kbase


                                      • Resources


                                      • Glossary


                                      • Desk Marketplace


                                      • MVP Corner


                                      • Word of the Day


                                      • Ask the Experts



                                          Zoho Marketing Automation
                                                  • Sticky Posts

                                                  • Automating leave alerts in Zoho Cliq

                                                    The constant ebb and flow of employee absences can disrupt projects and hinder productivity. With Zoho Cliq's leave alert automation, you can easily keep your team informed. Real-time notifications can be sent to team chats, ensuring that everyone stays
                                                  • Automating Employee Birthday Notifications in Zoho Cliq

                                                    Have you ever missed a birthday and felt like the office Grinch? Fear not, the Cliq Developer Platform has got your back! With Zoho Cliq's Schedulers, you can be the office party-cipant who never forgets a single cake, balloon, or awkward rendition of
                                                  • Convert a message on Cliq into a task on Zoho Connect

                                                    Message actions in Cliq are a great way to transform messages in a conversation into actionable work items. In this post, we'll see how to build a custom message action that'll let you add a message as a task to board on Zoho Connect. If you haven't created
                                                  • Cliq Bots - Post message to a bot using the command line!

                                                    If you had read our post on how to post a message to a channel in a simple one-line command, then this sure is a piece of cake for you guys! For those of you, who are reading this for the first time, don't worry! Just read on. This post is all about how
                                                  • Cliq Bots - How to make a bot respond to your messages?

                                                    Bots are just like your buddies with whom you can interact. They carry out your tasks, keep you notified about your to-dos and come in handy when you need constant updates from a third party application.  So, how can you make your bot respond to a message? The bot message handler is a piece of code triggered when a message is sent to the bot. Message handlers help you customise your bot responses to make it look conversational. The message input from the user can be either a string or an option selected


                                                  Manage your brands on social media



                                                        Zoho TeamInbox Resources

                                                          Zoho DataPrep Resources



                                                            Zoho CRM Plus Resources

                                                              Zoho Books Resources


                                                                Zoho Subscriptions Resources

                                                                  Zoho Projects Resources


                                                                    Zoho Sprints Resources


                                                                      Qntrl Resources


                                                                        Zoho Creator Resources



                                                                            Zoho CRM Resources

                                                                            • CRM Community Learning Series

                                                                              CRM Community Learning Series


                                                                            • Kaizen

                                                                              Kaizen

                                                                            • Functions

                                                                              Functions

                                                                            • Meetups

                                                                              Meetups

                                                                            • Kbase

                                                                              Kbase

                                                                            • Resources

                                                                              Resources

                                                                            • Digest

                                                                              Digest

                                                                            • CRM Marketplace

                                                                              CRM Marketplace

                                                                            • MVP Corner

                                                                              MVP Corner





                                                                                Design. Discuss. Deliver.

                                                                                Create visually engaging stories with Zoho Show.

                                                                                Get Started Now


                                                                                  Zoho Show Resources


                                                                                    Zoho Writer Writer

                                                                                    Get Started. Write Away!

                                                                                    Writer is a powerful online word processor, designed for collaborative work.

                                                                                      Zoho CRM コンテンツ






                                                                                        Nederlandse Hulpbronnen


                                                                                            ご検討中の方





                                                                                                  • Recent Topics

                                                                                                  • Lead Blueprint transition in custom list view

                                                                                                    Hi, Is It possible to insert the Blueprint transition label in a custom Canvas list view? I am using Lead module. I see the status, but it would be great if our users could execute the Blueprint right from the list view without having to enter the detailed
                                                                                                  • Time Based Workflow Rules for Projects and Tasks

                                                                                                    Project managers spend a significant amount of time manually monitoring task deadlines, notifications, and follow ups. Zoho projects' Workflow Rules help automate these repetitive processes and save valuable time. Workflow rules are a set of actions that
                                                                                                  • How to Send Weekly Scheduled Emails of a Custom View

                                                                                                    Greetings, We have a custom view called "All Employee View" for the Employee form. We are able to manually export that view using the "Export" button: However, we want to programmatically export this view as an XLS file each week and send it in an email
                                                                                                  • Extract first and last name

                                                                                                    I am trying to build a custom function in Flow, when a new Zoho Booking is added I want to split the Name field into first last name. I understand the function needs to be a string and this works but I am unsure how to write this in the flow script. result
                                                                                                  • Field value permission to set for automation to work as expected?

                                                                                                    I would like confirmation on the CRM software behaviour with the following configuration. A while ago I had discovered the solution by trial-and-error and now I don't remember what the conclusion was. I have a picklist field in the layout that I only
                                                                                                  • SEO for your Zoho Sites Website

                                                                                                    Join our live webinar to learn how to use Zoho Sites' SEO tools to boost your website's ranking. Our product specialist will demonstrate everything you need to know about optimizing your web pages to make them search engine friendly. Register here for free: https://www.zoho.com/sites/webinars/
                                                                                                  • Convert Leads to Deals in Portals?

                                                                                                    Is there a way to convert leads to deals, like the main program does? It doesn't seem to do it in portals. It seems a bit pointless having it.
                                                                                                  • Default view in Email on Company Module

                                                                                                    Is there a way to default the view on the COMPANY module to be "Emails Associated with the Related Contact" it is extremely frustrating to have to swap it every time. This is fairly new - it used to have it defaulted differently
                                                                                                  • Custom module in Portals won't edit

                                                                                                    I have a custom module but Portals access users can't edit it. They can create and delete though. In the Portals settings I have Create, Edit and Delete set turned on. Anyone know what this could be?
                                                                                                  • Kaizen #111 : Set default values based on Page Layouts using Client Script

                                                                                                    Hello everyone! Welcome back to another interesting Kaizen post. In this post, let us discuss how to set default values for fields based on different layouts using Client Script. In this Kaizen post, What are Page Layouts? Client Script is specific for
                                                                                                  • YET ANOTHER BUG: Client Script Flyouts no longer acting like Flyouts

                                                                                                    As per https://help.zoho.com/portal/en/community/topic/kaizen-157-flyouts-in-client-script one of the key benefits of a Flyout over a Popup is the ability to move it around the page. This no longer works. The "width" and "height" configuration settings
                                                                                                  • How to restrict on duty Requests?

                                                                                                    We need to restrict on duty requests for our employees, for example Work from Home limited to max 16 hours per week, or client visit limited to max 2 days per week How can we do that?
                                                                                                  • Does Client Script work on Zoho CRM Portal?

                                                                                                    Hi ! I create a new module to use at customer portal. But Client Script looks not work. Please help me clarify, thank you!
                                                                                                  • Translation in Zoho CRM now supports various regional languages

                                                                                                    Release status (Last modified on January 2, 2025): This feature is currently available for all users in enterprise and above editions, across all data centers. Hello everyone, Imagine a multinational company with teams spread across various regions, each
                                                                                                  • Drop down of Zoho users aka Employees

                                                                                                    Is there any field I can add to have an up-to-date list of current Zoho users ? Use case is for an employee to select their manager - however I don't want to have to manually populate a dropdown field every time someone joins or leaves our company. Why
                                                                                                  • Add multiple users to a task

                                                                                                    When I´m assigning a task it is almost always related to more than one person. Practical situation: When a client request some improvement the related department opens the task with the situation and people related to it as the client itself, the salesman
                                                                                                  • Last Name / First Name

                                                                                                    Hello , My company adds contacts on a "Last Name , First Name" basis. We've noticed that when viewing accounts there is no " , " (comma). It's VERY misleading. I have set the custom view to show "last name" "first name" instead it joins them both and
                                                                                                  • Launching CPQ for Zoho CRM! An in-built solution for bespoke quote management

                                                                                                    Hello everyone, We are thrilled to announce the public release of CPQ (Configure, Price, Quote) for Zoho CRM, which is a fundamental block in sales management. NOTE: CPQ was a public early access feature from March 2023 — January 2024. Since February
                                                                                                  • Unable to receive emails on outlook

                                                                                                    I am able to send on outlook, but unable to receive. None of the settings have been changed and it was working perfectly up until a few days ago.
                                                                                                  • Zoho Creator User Group meetups in a city near you!

                                                                                                    Greetings from the Zoho Creator team! We're excited to announce that we're hosting a series of Zoho Creator meetups in various cities across Australia and New Zealand. We invite you to join us for an exciting day of learning and fun. Our meetups are a
                                                                                                  • How to view shared mailbox in Outlook

                                                                                                    How to view shared mailbox in Outlook or in another software
                                                                                                  • Signature change

                                                                                                    I cannot see how to change signature or out of office details easily now in the new format.
                                                                                                  • Mas de 48 horas sin correo

                                                                                                    Estimados, llevamos más de 48 horas sin poder recibir correo y en este periodo hemos recibido información confusa y lo mas relevante es que Zoho dice que esta todo bien y no encuentra el error. Como deben comprender el perjuicio de no contar con un correo
                                                                                                  • Zoho Mail Domain Verification Issue

                                                                                                    Hi, I'm trying to verify my domain drinkkata.com but it shows the following error: Oops! Invalid domain detected by the system. Please contact <a href=mailto:{0}>support-as@zohocorp.com </a> for further assistance Could this be fixed please? Thank y
                                                                                                  • Forwarding or Aliasing Deactivated Mail Account

                                                                                                    We have an employee who has left the company, so his Zoho account is deactivated. I would like to forward any mail coming to his account to another employee, but as it is deactivated, I can't forward it. I also tried setting the same username up as an
                                                                                                  • Is there a way to force a page refresh after changing a Subform via Workflow / Function?

                                                                                                    I have a workflow which triggers a function, and in this function i am changing the values of a certain subform. The changed are only visibile when i manually refresh the page and this is a no-no for my use-case. When other workflows, that change certain
                                                                                                  • DKIM cannot be enabled for the domain as no verified default selector present

                                                                                                    Can't get the DKIM working. May you please check my account (nksy.us) to see what's wrong?
                                                                                                  • The SPF record verification fails

                                                                                                    I have set the SPF record for my domain correctly, according to zoho's SPF configuration guide. Also I used some tools to check my SPF record, and all showed it is correct. But the control panel still shows that I haven't finished the verification. So how to deal with it? Thanks in advance.
                                                                                                  • TASKS - Dashboard to show ALL Tasks from ALL apps.

                                                                                                    The Unified Tasks View is useless without the other main zoho apps (Desk, Books & even FSM now) We need to see all our tasks under on pane of glass. The Zoho developers are out of touch with real business workflows. So how it was designed they want us
                                                                                                  • BUG ALERT: Client Script + Commands -> $Page contextual data is not updated

                                                                                                    When using the new Client Script Commands feature, there is an issue with the Client Script $Page contextual data not accurately being updated each time a Command is run. Assuming a Client Script Command called "Client Script Command Bug" with the following
                                                                                                  • Inconsistency Between UI and API for Future Status Subscription Start Date

                                                                                                    Hi Zoho Team, I noticed an inconsistency in how the start date is displayed for future status subscriptions in Zoho. The UI shows one start date, while the API response seems to return what looks more like the activation date (ActivateDate). Could you
                                                                                                  • Client Script event on any field of a Detail page

                                                                                                    Hi everyone! I'd like to trigger a Client Script when a user modifies a field - any field - from the Account Details page, how can I do this? I don't want to trigger it on a specific field, but on all of them. Thanks in advance!
                                                                                                  • ZOHO Reports - Filter Logic?

                                                                                                    Hi, I need a way to apply filter logics such as ((1 AND 2) OR 3). All I can see as of now is a way to enter different AND filters in the respective filter column. But how can I add an OR filter? Any advice would be highly appreciated. Mark
                                                                                                  • spark sync problem with iphone

                                                                                                    Hello, I am using the spark application on iphone 15 pro max and 16 pro max. After several days of installing the account on spark i dont get notifications on new emails, i have to open the app in order to receive the new emails. After sending email to
                                                                                                  • Ability for admin to access or make changes in zoho form without asking for ownership

                                                                                                    Currently in zoho form only form owner can make the changes in the form and if someone else has to make changes then we have to transfer the ownership to them and even admin also cant access it . So i think admin must have the ability or option to access
                                                                                                  • Listado con descripción de artículos

                                                                                                    Buenos días En nuestra organización tenemos artículos genéricos en los cuales concretamos medias o colores o acabados en la descripción del artículo (ejm: tenemos el artículo estor a medida y en la descripción ponemos la medida concreta que necesita el
                                                                                                  • Não consigo receber e-mails de algumas instituições como por exemplo: banco

                                                                                                    Não consigo receber e-mails de agências, bancos e instituições. Envio normalmente, mas os e-mails enviados por eles não chegam para mim, mesmo aqueles que são respondidos no próprio e-mail enviado por mim.
                                                                                                  • How can I send a reply to 100 unread emails in one click using a Zoho account?

                                                                                                    When I select a single email, the 'Reply All' option appears, but when I select multiple emails, the 'Reply All' option does not appear.
                                                                                                  • Sync Gmail for Admins

                                                                                                    Hello. We migrated from gmail to Zoho mail a few years ago, but some users want to be able to use gmail. I have set up dual delivery in the Zoho Mail Admin console. This is working fine. I can't figure out how to sync outgoing emails. Specifically, if
                                                                                                  • Export Tasks From ToDo List whic are in side Zoho Mail

                                                                                                    Hi, I have a list of tasks in ToDo List inside Zoho Mail. How can I export these tasks to Excell sheet? check the attachment for more clarification.
                                                                                                  • Next Page