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,
- Click ' Settings ' in Cliq's top nav bar.
- Select ' Integrations '.
- 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 :
- 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.
- Click ' Edit Code ' under the bot incoming webhook handler.
- 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:
- // Incoming Webhook Handler Code Snippet
- response = Map();
- title = body.get("title");
- priority = body.get("priority");
- description = body.get("description");
- url = body.get("url");
- id = body.get("id");
- status = body.get("status");
- assignee = body.get("assigned_to");
- 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 };
- return response;
To be done in Zendesk
Create a Target:
- Create an extension. To do so, click 'Extensions' under 'Settings'
- Click 'Add Target' under the targets tab.
- Click 'HTTP target' and give a name, URL, method.
- Give your bot's incoming webhook URL along with the zapikey parameter. Take a look at how to create a zapikey here .
-
Set your HTTP method as POST.
-
Select 'Create Target' and click Submit.
Sample Bot Incoming Webhook URL:
- https://cliq.zoho.com/api/v2/bots/demobot/incoming?zapikey= <zapikey>
-
- https://cliq.zoho.com/api/v2/bots/demobot/incoming?zapikey=8899ghcbgyatgheyruhjkfhasgrteh
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.
- Navigate to the Triggers tab and click ' Add Trigger '
- Give the trigger a name, description and set a condition. Take a look at the sample condition used for the example shown below.
- Under Actions, select ' Notify Target ' and select your target name.
- 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.
- Click Save!
Sample Trigger Code Snippet:
- {"title":"{{ticket.title}}",
- "description" : "{{ticket.description}}",
- "priority":"{{ticket.priority}}",
- "url": "{{ticket.url}}",
- "id":"{{ticket.id}}",
- "status":"{{ticket.status}}",
- "assigned_to":"{{ticket.assignee.name}}"
- }
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:
Cliq Bot Handlers :
https://www.zoho.com/cliq/help/platform/bothandlers.html
Zendesk Triggers :
https://support.zendesk.com/hc/en-us/articles/203662156-Zendesk-placeholders-reference
Notifying Targets :
https://support.zendesk.com/hc/en-us/articles/203662136
Best,
Manasa
Cliq
Access your files securely from anywhere
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Manasa Manogaran
Eric Hirst
Sticky Posts
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 ofAutomate your status with Cliq Schedulers
Imagine enjoying your favorite homemade meal during a peaceful lunch break, when suddenly there's a PING! A notification pops up and ruins your moment of zen. Even worse, you might be in a vital product development sprint, only to be derailed by a "quickBulk user onboarding for Cliq Channels in a jiffy
As developers, we frequently switch between coding, debugging, and optimizing tasks. The last thing we want is to be burdened by manual user management. Adding users one by one to a channel is tedious and prone to errors, taking up more time than we couldConvert 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 createdUnfurling Unlimited Possibilities in Zoho Cliq 🔗
Are you tired of your app links looking plain? Imagine if the shared links came to life with custom previews, organized data, and one-click actions, making chats more interactive. With the Cliq platform's unfurl handlers, let's see how developers can
New to Zoho TeamInbox?
Zoho TeamInbox 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
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
TDS Filing
Is there any option for automatic 26Q and 24Q filing in Zoho books. Even Tally has this option. Why don't Zoho has this ? Is there any customisation available for this ?Empowered Custom Views: Cross-Module Criteria Now Supported in Zoho CRM
Hello everyone, We’re excited to introduce cross-module criteria support in custom views! Custom views provide personalized perspectives on your data and that you can save for future use. You can share these views with all users or specific individualsSorry to inform you that currently we cannot access the subform fields through writer deluge (zoho.writer.mergeAndSend).
This is the premium support answer from zoho. It means we cannot merge and send thru deluge related records (sub forms) items... Has anybody suffered from the same ordeal ? DO you have a workaround ? If not can you vote for this feature to be added toCross module filtering is now supported in CRM
Editions: All DCs: All Release plan: This enhancement is being released in phases. It is now available in AU, JP, and CN DCs. Help resource: Advanced filters The Cross-module filtering enhancement is now available to all CRM accounts in the followingQuotes
Has anyone figured out how to automatically upload a quote that was signed via Zoho Sign and insert it directly to that leads file and push it through the pipeline to proposal signed status?I wan to schedule a meeting report From previous Thursday to this thursday of this week on Every 6 pm want to recive this report in zoho CRM
I wan to schedule a meeting report From previous Thursday to this thursday of this week on Every 6 pm want to recive this report in zoho CRM. How I Can achive this in Zoho CRM.Importing a contact with a linked product
Hi, I'm trying to import my contacts from an excel spreadsheet and each of those contacts have fields that relate to products. Is there a way that I can import the contact with their linked product? Some of the contacts in my spreadsheet have multipleCRM - Workflow Rules to be applied and work across modules
Hello, It seems that you can't use workflow rules in CRM to work across modules, is this correct? I need a customer account status to be changed IF there have been no new deals or new quotes in the last 6 months. I can't see this is possible? I can createAuto assign account owner
hi, i need to auto assign leads and accounts to an owner by rules. i have created all the territories i need, and all territories have their owner. but when i want to auto assign a new or an existing account to a user by the rules of territories, onlyHow do I enter phone extensions?
How do I add a phone extension correctly so that when I dial the main number it will pause and dial the extension of the contact I want to talk to GregHow do you make tabs and place certain leads in them?
I am trying to figure out how to make a tab for my Florida contacts, California contacts and New York contacts. I make a new view named "Florida Leads" but when I click on it, ALL of my leads pop up in the same view... Is there a way to move leads into different categories? Thanks, WayneBoolean Fields in Mail Merge Displaying as Checkmarks
I'm really liking the new mail merge functionality. It's replaced the Zoho Sign extension for us. One problem I've seen is that boolean operators (i.e. Checkbox fields) in CRM merge as "True" or "False". This looks a little ugly in my final document —5名限定 課題解決型ワークショップイベント Zoho ワークアウト開催のお知らせ(7/24)
ユーザーの皆さま、こんにちは。Zoho ユーザーコミュニティチームの藤澤です。 7月開催のZoho ワークアウトについてお知らせします。 2ヶ月ぶりに、渋谷にて「リアル開催」します！ ▷▷詳細はこちら：https://www.zohomeetups.com/20250724Zoho ━━━━━━━━━━━━━━━━━━━━━━━━ Zoho ワークアウトとは？ Zoho ユーザー同士で交流しながら、サービスに関する疑問や不明点の解消を目的とした「Zoho ワークアウト」を開催します。 Zoho サービスで完了させたい設定やカスタマイズ、環境の整備など……各自で決めた目標達成に向け、Web to lead form not working
I am starting to use this Zoho product (3 users for free) to see if it really does what it should prior to making a purchase decision. One of the important parts of the ZOHO CRM is the ability to create a web form that auto generates a lead. We have setIs this a valid email from Zoho or a scam?
Hi, I received an email advising me to update MX records for Zoho mail. Is it legitimate? Thanks, Nelson. Dear Admin, You may know that your domain (eg, yourcompany.com) has an MX record that points to an email server configured to process email for your domain. We have noticed that some of our customers have used Zoho IP address (instead of DNS server name) in their MX records to specify the mail server. This is NOT recommended practice. Vendors will sometimes change IP addresses for number of validCanvas View - Print
What is the best way to accomplish a print to PDF of the canvas view?Updating task using excel file
Hi, Is there a way to update existing tasks using excel file import? ThanksTip 14: How to iterate a set of Deluge code a specific number of times.
Hello folks, As you might already know, recursive functions are used to perform a particular action a specific number of times. We had explained this in detail in our Tip #2. Similarly, there is another way in which you can iterate a set of Deluge code 'n' number of times. All you need to do is to create a List and use the For each index task to iterate it for a specific number of times. Here are a few use cases where this would be useful to you: To create 'n' number of duplicate records forIs it possible to register webhooks in Zoho CRM using API?
Hello, I am trying to register a webhook in Zoho CRM programmatically (using the API). Specifically, I want to register a webhook that is fired when new Contacts are created in the CRM. I was able to setup a webhook using the UI, by creating a rule thatonly lastname as index(?) field in custom module
Hello, I have a small problem. I have created a custom module. The data records are only labeled with the last names. Also in the lookup etc.... It's stupid if you have different first names with the same surname. Then I only ever see the surname. InCan't set conditional layout rule on lookup field in Zoho CRM
Namaskaram Zoho CRM team, Usually any fields of module except mandatory fields can be hide using conditional layout rules. But that can't be set on lookup fields event that is not a mandatory fields. Many users are in need of that. Crafted withRestrict Zoho One Account Notifications to Admins
Hi Zoho One Team, I hope you're doing well. We recently noticed that end users are receiving administrative pop-ups in Zoho One, such as the DKIM configuration notice (screenshot attached). This type of notification is only relevant to administratorsAll about Users in Zoho Projects
To form a functional team, businesses should define different types of users in their team. Businesses can be effectively managed by inviting users to various roles. And, the person who has the administration privileges can invite or add users to various roles in the project. Two types of users Before going into the steps to add users to your portal or project, let's understand the different types of users: Portal Users - Users who work for the projects in your team. ~ PortalAnnouncing Kiosk 1.1 - Customize screen titles, configure new fields & actions, use values from your Kiosk to update fields, and more.
Hello all We are back again with more enhancements to Kiosk. So what's new? Enhancements made to the Components Add titles for your Kiosk screens and adjust its width to suit your viewing preferences. Three new fields can be added to your screen: Percentage,Cannot associate event with other objects when creating?
I am attempting to associate an Event with one or more other objects when creating it via the API. According to the API docs, the "Related_To" property is a jsonobject even though the description says "Provide the details about the entities the eventMissing Payload Details
Hi All, Does anyone know how to fix missing webhook payload data in the next step of the flow? Payload comes into the webhook -- All details here When i go to use the webhook data in the next step -- the majority of the payload data is missingZoho Projects API 100 requests/2 min. Limit
Hi Requesting clarification on the API documentation. "You can invoke or call an API for 100 times in a span of two minutes. If you invoke more than 100 times, the particular API request will be locked for the next 30 minutes. " Does this limit applyCustomer address in Zoho Bookings
Hello, Is it possible to add customer address information to the Zoho bookings appointment screen? Or have it pull that information automatically from the CRM? We are wanting to use this as a field management software but it is difficult to pull the address from multiple sources when it would be ideal to have a clickable address on the appointment screen that opens up the user's maps. It would also be advantageous for the "list view" to show appointment times instead of just duration and bookingAutoScan Not Working Since April -Support says it with engineering
Hi there, Autoscan has not been working on my account since April. Without this feature, completing expenses reports is laborious and error-prone. I keep asking for updates seeing as this is a critical feature, but told that it's being looked into andCalendar Connection Enhancement
Hello everyone, Greetings from the Bookings team. We're here to announce an important Calendar enhancement that will roll out soon. Let's take a look at what's being changed. Improved and more straightforward UI The Calendars UI is undergoing a completeBookings to CRM - New Events and Contacts
Hello, I have an issue with appointments taken by clients from a Zoho Bookings page. Previously when an appointment was reserved, if there were no client created in Zoho CRM, it would create it in the CRM through the integration between both platform.Generating Discount Coupons for Zoho Bookings
Hi, Is there provision to generate Discount Coupons for appointment bookings? I could not see that in the settings and this is very much needed. Please suggest us. ThanksWhen will Sales Order and Invoice Synchronisation with Zoho CRM be Available?
When will Sales Orders and Invoices, created in Zoho Books or Inventory be made available in Zoho CRM? John Legg Owner: The Debug StoreIn the Blue Print Transition requirement received it will show 8 check field in pop up if they any one of this field then only move to next stage Ist quote
In the Blue Print Transition requirement received it will show 8 check field in pop up if they any one of this field then only move to next stage Ist quote Pls help how i fix thisMultiple Products on Ticket
Good morning. We will classify all tickets based on the product. Users sometimes send different requests on the same ticket, so we are facing some challenges. Is there a way to add more than one product to the ticket, or is there a way to tie the productDesk - CRM Integration: SPAM Contacts (Auto Delete)
SPAM contacts is a useful feature, but when the CRM sync is used, it is very frustrating. When a contact is marked as SPAM on Desk, I wish to do the same on CRM. When a SPAM contact is deleted, I would like it deleted from CRM. The feature looks half-baked.Date Import Problems
I'm trying to import products from csv/xls files, but I can't get the Sales Start Date field to import. I know the import is working because all the other information is imported, but the Sales Start Date field is left empty. I think it must be a format problem. The date format I am trying to import is DD/MM/YYYY. This is also how my date preferences are set up in Zoho CRM. Do I need to use a different format to import the date field?Surely it's time Inline editing from views
I think the first request I found for in-line editing from grids was approximately 12 years ago - that post was locked because it was suggested Zoho sheetview solved the problem. However, it's now 2024, and in-line editing from grids is just a basic expectation.How to work with getFieldNames formdata functions ,Any Examples
I don't find any example showing usage of getFieldNames. Where do i find .is there any Help documents availableAllowing subqueries in FROM clause
When building a Query table in Zoho Reports, I encountered an error when attempting to put a subquery in the "FROM" clause of my statement. Why isn't this currently supported? Is there a plan to implement this functionality in the future?Next Page