Supported Plans : Premier, Premier Trial, ZohoOne, ZohoOne Trial, Remotely, and Remotely Trial

Benefits of using custom functions

1. Custom function is an efficient and time-saving method to perform repetitive tasks.
   
2. A chunk of deluge scripts with the aim of executing a particular task are encapsulated and implemented at multiple events, making it a reusable entity.
3. It allows you to automate certain processes like calling a webhook, sending notifications, or performing an action at the trigger of an event.
4. The modular nature of the code makes it easier to manage and use them.
5. Deluge comes with built-in functions to make scripting easier.
6. Sprints provides a list of pre-built functions that allows you to execute a few default tasks.
7. Enable Sprints to interact with third party services using a secure authentication mechanism.

Gallery functions

Note: Integrating with other services requires you to create a connection.

1. Create a connection for the Slack service with the scopes "chat:write:bot".
2. Find 'slackconnection' & replace it with the connection name you've provided.
3. Configure valid slack channel ID in "channelId" custom parameters on the left side.
4. Switch off Use Credentials of Login User  while creating the connection.
   

Note: Integrating with other services requires you to create a connection.

1. Create a connection for the ZohoCliq service with the scopes "ZohoCliq.Webhooks.CREATE".
2. Find 'cliqconnection' & replace it with the connection name you've provided.
3. Configure valid Cliq channel name in "channelUniqueName" custom parameters on the left side.
4. Switch off Use Credentials of Login User while creating the connection.

Function Logs

Manage custom functions

1. Create function
   
2. Edit function
   
3. Delete function
   
4. Create function from gallery
   
   

Create function

1. Click on the setup icon to navigate to the Setup page.
2. Select Automation.
3. Select Custom Functions.
   
4. Click the dropdown on the Function button.
           
   
   
5. Select the Function. The Create Custom Functions window will appear.
   
6. Enter Display Name.
7. Enter Function Name.
   
Note: According to the general naming convention, function name cannot contain spaces.
8. Select Category as Automation.
9. Select the Module in which the function needs to be executed.
10. Select the Trigger Event at which the function needs to be executed. The trigger events are dependent on the module that you select.
11. Provide a Description of the function.
12. Enter Parameter Name and select the Parameter Value. Or, provide custom parameters and values.
Note: A parameter is a variable assigned to a value in a function. The parameter value is the information passed in the function. In other words, the parameter name is the container and the parameter value is the information contained in it. These allow you to build a logical script into which actual input data can be passed when the function is invoked
13. Script the function using the Deluge script builder.
    
    
    
    
    
    
    
14. Click Save to complete creating the function or click Save and Execute to complete creating the function and execute it.
    
    

Edit function

1. Go to the listing page of Custom Functions .
2. Hover on the Function that needs to be edited. The wheel icon will appear.
3. Click the dropdown arrow.
   
   
   
   
   
4. Select Edit . The Edit Custom Action window will appear.
5. Make the changes.
6. Click Save to save the changes.
   
   

Delete function

1. Go to the listing page of Custom Functions .
2. Hover on the Function that needs to be edited. The wheel icon will appear.
3. Click the dropdown arrow.
           
   
   
4. Select Delete . A confirmation pop-up will appear.
5. Select the checkbox to agree that you've been warned about the loss of related data.
6. Click the Yes, delete button. The function will be deleted and removed from the listing page.
   
   

Create gallery function

1. Click on the setup icon to navigate to the Setup page.
   
2. Select Automation .
3. Select Custom Functions .
4. Click the dropdown arrow on the Function button.
   
   
   
   
   
5. Select Gallery Function .
6. Hover on the required function.
   
   
   
   
7. Click the Create button. The Create Custom Function window will appear.
   
8. Enter Display Name
9. Enter Function Name .
   
Note: According to the general naming convention, function name cannot contain spaces.
10. Select Category as Automation .
    

Note: 
1. The Module, Description, Parameter Names, and Parameter Values are predetermined based on the logic of the probable scenarios. You can edit them if necessary.
   
1. A parameter is a variable assigned to a value in a function.
   
1. The parameter value is the information passed in the function. In other words, the parameter name is the container and the parameter value is the information contained in it. These allow you to build a logical script into which actual input data can be passed when the function is invoked.
   
11. Select the Trigger Event at which the function needs to be executed. The trigger events are dependent on the module selected.
              
    
    
12. Edit the existing script in the Deluge script builder to suit your requirement.
13. Click Save to complete creating the function or click Save and Execute to complete creating the function and execute it.
    

Manage standalone functions

Create standalone function

1. Click on the setup icon to navigate to the Setup page.
   
2. Select Automation.
   
3. Select Custom Functions.
   
4. Click the dropdown on the Function button.
   
5. Select the Function. The Create Custom Functions window will appear.
   
6. Enter Display Name.
   
7. Enter Function Name.
   Note: According to the general naming convention, function name cannot contain spaces.
8. Select Category as Standalone.
   
9. Select the Recurrence Type to determine the frequency at which the function needs to be executed.
   
10. Enter schedule specifications based on the recurrence type.
    
11. Provide a Description of the function.
    
12. Script the function using the Deluge script builder.
    
    
13. Click Save to complete creating the function or click Save and Execute to complete creating the function and execute it.
    

https://sprintsapi.zoho.com/zsapi/team/{teamId}/customfunction/{functionId}/execute/?arguments={"parameters":{"key1":"value1","key2":"value2", ....upto 25 parameters }}

Access parameter

You can pass custom parameters in standalone functions. Parameter refers to the value that is passed in the function. Passing this value in the function enables you to get the required response or output. The format for the parameter is that of key value pairs.

To access param "key1" in deluge, enter value = sprintsAPIRequestMap.toMap().get("params").toMap().get("key1");

Note:

1. You can customize the status code and send custom headers in your request.
   
2. You can enter up to 25 parameters.

Define response object

Points to remember

1. A maximum of 20 parameters can be included while creating a function.
2. A maximum of 15 custom parameters can be included while creating a function.
3. A function can be disabled or enabled.
4. The name of the function cannot be modified once created.
5. When a function execution fails continuously for 15 times, a Function Disable Alert email will be sent to the team owner and to those who created and updated the function.
6. A function will not be executed if it is disabled.
7. Connections enable integration with other services. To create a connection, go to Automation and select Connections.
8. A function can be manually executed but the parameter value will only be passed with 'null' value.
9. Functions that are executed will be recorded under Function Logs.
10. Function logs that are older than a month will be permanently deleted.
11. You can try to execute a failed function thrice.
12. You cannot execute a function that was already executed successfully.