Standalone Functions | Administrator Guide| | Zoho People 5.0 help

Standalone Functions - Zoho People

Standalone Functions in Zoho People are custom Deluge-based scripts designed to execute independently when triggered via API calls. These functions accept external parameters, enabling dynamic data processing and logic execution within Zoho People. By using a unique method name and custom input variables, Standalone Functions facilitate seamless integration between Zoho People and third-party systems, making them ideal for automating tasks, syncing data, or extending functionality beyond standard workflows.

Set Up Standalone Function in Zoho People

To set up standalone function in Zoho People:
  1. Navigate to Settings > Developer Space > Standalone Function.


  2. Click Add Standalone Function.


  3. Enter a name for the Standalone Function.
  4. Click Edit Parameters, to define the Method Argument and its data type.
    Idea
    A maximum of 15 parameters can be configured.
    Info
    Arguments are the values passed into a function or method when it's called, while data types specify the kind of data a variable or function argument can hold.

  5. In the Method name, enter a unique method name for the Standalone Function.
    Info
    When invoking a standalone function via an API call, Zoho People needs to precisely identify which method or action to execute. If multiple methods share the same name, it would lead to ambiguity and errors in function execution, as the system wouldn't be able to distinguish between the different methods.
  6. In the deluge section enter you standalone function Deluge code. For more information, refer to Deluge Script - Reference Guide.
  7. Click Save and Execute to run and test the function.
  8. Click Save to save the Standalone Function.

OAuth 2.0 Access

You can make Standalone Functions accessible through the OAuth 2.0 protocol, allowing other applications to connect with Zoho People without needing your username or password. With scopes to control what data can be accessed, OAuth 2.0 ensures that only specific, authorized actions are allowed. This makes it easy—and secure—to integrate Zoho People with third-party systems while keeping your data safe and your privacy intact.

To make a function available through the OAuth 2.0 method, you must first register your client with Zoho People. Please refer to Steps to Generate OAuth Token.

Invoke Standalone Function via Zoho People API

Use the Zoho People API to invoke a standalone function from an external application or system. For API details, refer to Invoke Standalone Function API.

  • Use a POST request to call the standalone function.

  • The API endpoint for executing a standalone custom function is:

    Quote
    https://people.zoho.com/api/v3/function/(\w+)/execute

    Info
    Replace (\w+) with the unique method name of the standalone function, which is available in the standalone function created in Zoho People.

  • In the request body:

    • Specify any input parameters your function requires.

    • Provide the optional parameters in JSON format under the key arguments.

    Example body:

    json
    {
  "arguments": {
    "parameter1": "value1",
    "parameter2": "value2"
  }
}

Test Standalone Function in Postman

You can test the standalone function using Postman:

  1. Open Postman and create a new request.

  2. Connect to the standalone function’s REST API using the following details:

    1. Request method: POST

    2. Authorization: OAuth 2.0

    3. Callback URL: https://oauth.pstmn.io/v1/callback

    4. Auth URL: https://accounts.zoho.com/oauth/v2/auth

    5. Access Token URL: https://accounts.zoho.com/oauth/v2/token

    6. Scope: ZOHOPEOPLE.automation.ALL

    7. Generated Client ID, Client Secret

    8. Pass the arguments to the params property of the APIRequest object, and then execute the function using the POST method.