An example for Function API

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 
  1. Click the gear icon [] in the right menu.
  2. Select Settings from the dropdown.
  3. In the Settings page, click Function API under Developer Space.

  4. In the new page, click Create Configuration.
  5. In the configuration details page, give a name, icon, and description.
  6. 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.
  1. payloadArray = list(body);
  2. ticket = payloadArray.get(0);
  3. ticketPayload = ticket.get("payload");
  4. desc = ticketPayload.get("description");
  5. subject = ticketPayload.get("subject");
  6. response = invokeurl
  7. [
  8.  url: "https://connect.zoho.com/pulse/api/addTask"
  9.  type: POST
  10.  parameters: {"scopeID":12266000000002002,"boardId":12266000000016001,"title":subject,"desc":desc,"sectionId":1226600000031376,"position":1}
  11.  connection:"zohoconnect"
  12. ];
  13. info response;
  14. return {"statusCode":"201","response":"Task Created Successfully"};
Step 3: Generate the API endpoint URL in Zoho Connect.  
  1. Click Expand found next to API endpoint.
  2. 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!