Managing Function API in Zoho Connect

Managing Function API in Zoho Connect

Feature Availability

Overview
Once you set up a Function API, Zoho Connect lets you manage all your Function API configurations from one place. You can create new configurations to set up integrations, edit existing ones to update how your applications communicate, and disable or delete the configurations you no longer need.

Who can create a Function API

By default, only network admins can create a Function API in Zoho Connect.

How to configure a Function API

  1. Click the gear icon [] from the right menu, then select Settings.



  2. Under Developer Space, click Function API.



  3. On the Function API page, click Configure.

     

  4. On the Configuration Details page, enter the required details.

     
  5. Click Save & edit code.
  6. Click Write function in the respective handler to write a custom function to define how the request should be handled.



  7. Click Expand next to API endpoint.



  8. Click Generate URL.



  9. Copy the URL and paste it in the other application to start sending requests to your Function API.

Notes
You can create up to 100 Function API configurations in your network.

How to regenerate the API endpoint URL

Regenerating the API endpoint URL will invalidate the existing URL and generate a new one. Make sure to update the new URL in the other application after regenerating.
  1. On the Function API page, click the required configuration under My Function APIs.



  2. Click Expand next to API endpoint.



  3. Click Regenerate.



  4. Copy the new URL and update it in the other application.

How to edit a Function API

  1. On the Function API page, select the required configuration under My Function APIs.



  2. In the configuration details pop-up, click Edit configuration.


  1. Make the required changes and click Save.



How to disable a Function API

Notes
Disabling a Function API will suspend it temporarily without deleting any of its configurations.
  1. On the Function API page, click the required configuration under My Function APIs.



  2. In the configuration details pop-up, toggle the Enabled button in the top-right corner.


To enable the Function API, follow the same steps above and toggle the button to enable it.
Idea
Disable the Function API while making changes to the handler code to prevent unwanted invocation.

How to duplicate a Function API

  1. On the Function API page, click the required configuration under My Function APIs.



  2. In the configuration details pop-up, click the plus icon in the top-right corner.

A duplicate of the selected Function API configuration will be created under My Function APIs.

How to delete a Function API

  1. On the Function API page, click the required configuration under My Function APIs.

  1. In the configuration details pop-up, click the trash icon [] in the top-right corner.



Execution logs

The execution logs in each Function API configuration record the details of every request handler activity over the past year. This includes the execution time, status, parameters passed, and the data returned. You can refer to these logs to monitor your Function API's performance and troubleshoot any issues.

Execution limit

Your network has a daily limit on the number of times a Function API can run. Function API is available only on the Ultimate plan, with a limit of 20,000 executions per day. You can create up to 100 Function API configurations in your network.
Once the daily limit is reached, all Function APIs in your network will be paused for the rest of the day and will resume at 12:00 AM based on your network's data center location.
You can view the number of executions used for the day in the Usage Details section at the top-right corner of the Function API page.
   

If you have any questions regarding Function API in Zoho Connect, please write to our support team at support@zohoconnect.com. We're always happy to help!