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 call back request structure doesn't match the requirements of the Zoho Connect's create task API and hence it is not possible to share the data as it is. So, a Function API is used to customize the structure of the incoming request to meet Zoho Connect's requirements.
Step 1: Create a Function API configuration
- Click the gear icon [
] in the right menu.
- Select Settings from the dropdown.
- In the Settings page, click Function API under Developer Space.
- In the new page, click Create Configuration.
- In the configuration details page, give a name, icon, and description.
- Click Save & edit code.
Step 2: Since the POST request is made from Zoho Desk, write the code mentioned below in the post request handler.
- payloadArray = list(body);
- ticket = payloadArray.get(0);
- ticketPayload = ticket.get("payload");
- desc = ticketPayload.get("description");
- subject = ticketPayload.get("subject");
- response = invokeurl
- [
- url: "https://connect.zoho.com/pulse/api/addTask"
- type: POST
- parameters: {"scopeID":12266000000002002,"boardId":12266000000016001,"title":subject,"desc":desc,"sectionId":1226600000031376,"position":1}
- connection:"zohoconnect"
- ];
- info response;
- return {"statusCode":"201","response":"Task Created Successfully"};
Step 3: Generate the API endpoint URL in Zoho Connect.
- Click Expand found next to API endpoint.
- Click Generate URL.
Step 4: Configure the outgoing webhook in Zoho Desk with the generated URL from Zoho Connect network as the call back URL.
Now, whenever a ticket is added in Zoho Desk, a new task is created in Zoho Connect. Similarly, a configuration to update and delete tasks can also be done.
If you have any questions regarding Function API, please write to us at support@zohoconnect.com. We'll be happy to help!
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 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:
New to Zoho Writer?
Create. Review. Publish.
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
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.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Overview of Function API
Feature Availability Overview Function API in Zoho Connect provides an authenticated API endpoint to establish a connection between two applications and automate workflows. It also includes handlers that let you format the request and response ...Create, edit, disable and delete Function API
Feature Availability Who can create a Function API? By default, only the network admins can create a Function API. However, if allowed, selected users can also create a Function API. How do I create a Function API configuration? Click the gear icon ...Regenerating the API endpoint URL
Feature Availability Overview The API endpoint is an authenticated URL that lets another service to send requests and access the data in a network. It is necessary that the URL is kept safe and not shared with others. However, in case the URL gets ...Configuring a Scheduler
Feature Availability Configuring a Scheduler A scheduler is triggered at the specified time to complete the defined action. The action to be performed is written as a custom function using Deluge scripts in the scheduler handler. The following ...Manuals overview
Use Manuals to build your team's knowledge base. Think of it in terms of an online library that your team can draw on when needed. For example, your company's policies, best practices guide related to work, API documentation, and other resources can ...
New to Zoho LandingPage?
Zoho LandingPage Resources