Manage Custom Functions
Business Uses for Custom Functions
- Use Custom Functions to automatically move cards to the previous or next stages, when specific transitions or card updates are performed.
- You can also post comments, messages or updates to other applications used in your organization like Zoho Desk, Zoho Cliq, or MS Teams, using Custom Functions.
API Authentication for invoking custom functions
- OAuth 2.0
- API key
Use the following Request URL format to authenticate using API key:
- https://core.qntrl.com/blueprint/ <organization-name>/customfunction/executeFunction/<custom-function-ID>
- Do not share the API key with unauthorized or external users, as any user with access to the API key can perform all operations.
- We recommend that you regenerate the API key periodically to ensure security.
|
OAuth 2.0 authentication
|
API key authentication
|
|
OAuth 2.0 protocol uses
header for authentication.
|
API key is authenticated in the
Request
URL .
|
|
All the custom functions in
Qntrl can be authenticated using OAuth 2.0 protocol.
|
Only
standalone functions can be authenticated using API key.
|
|
In OAuth 2.0 authentication, the access token
expires every hour . Refresh tokens are used to generate new access tokens.
|
API key has to be generated just once. It
does not expire .
|
Business Scenarios
-
Update your company’s website dynamically with the number of open job positions once a candidate is selected in the recruitment process.
-
Calculate the total time spent by a user on each stage and email a detailed summary to the client for billing.
-
Integrate Qntrl with a calendar application, and send interview invites to the shortlisted candidates.
-
Integrate Qntrl with Jira to add a card in Qntrl for every project created in Jira.
Create a card-based custom function
-
Navigate to
and select Custom Functions under Advanced from the menu.
-
Click New Custom Function.
-
Fill in the details:
-
Module Type : Select Cards if the function requires card arguments.
-
Function Name : Name your function.
-
Return Type : Return type for card-based custom functions will always be void .
-
Description : Describe how the function works.
-
Arguments : Enter the arguments that are used in the code snippet. You can either use the Custom Value or choose a Form Field from the dropdown. Form fields capture dynamic values from card fields corresponding to the custom function.
-
Connections : Configure internal or third-party integrations here. Learn more about connections.
-
Code your custom function.
-
Click Save or Save & Execute.
- Card-based custom functions can only be invoked using OAuth 2.0 protocol.
- Only card-based custom functions can be invoked from blueprints and business rules.
- Module type , once selected, cannot be edited.
- Arguments for dropdown fields can be passed using the field ID obtained via API.
Create a standalone custom function
-
Navigate to
-
Click New Custom Function.
-
Fill in the details:
-
Module Type : Select Standalone if the function requires only independent arguments.
-
Function Name : Name your function.
-
Return Type : Select a return type for the custom function.
-
Description : Describe how the function works.
-
Arguments : Enter the arguments that are used in the code snippet.
-
Connections : Configure internal or third-party integrations here. Learn more about connections.
-
Code your custom function.
-
Click Save or Save & Execute.
- Standalone custom functions can be invoked using OAuth 2.0 protocol or API key.
- Module Type , once selected, cannot be edited.
Invoking standalone functions using API key
To invoke a standalone function using API key, it has to be enabled first. Make sure that the API key is generated in the Organization Setup .
- Hover over the custom function and click
.
- Select REST API from the dropdown.
- Toggle the button next to the API key to enable it.
Scheduling custom functions
Associate custom function with blueprints
-
Navigate to
- Select an existing orchestration or create a new one. Learn more about orchestration.
- You will land in Step 1: Create Form.
- Navigate to Step 2: Design Blueprint .
-
Click on a transition and navigate to the After section in the right panel.
-
Now, under Instant Actions or Schedule Actions , click the
icon next to Associate Custom Functions .
-
Select a function from the Function Gallery or Configured Functions.
-
While associating a function from the gallery, click Save as New.
-
While associating a configured function, click Save or Save & Execute .
-
Once the functions are configured, Save the blueprint.
Associate custom function with business rules
-
Navigate to
- Create a new business rule or open an existing rule. Learn more about business rules .
- Fill in the rule details and move to Criteria & Actions.
- Now , click the
-
Select a function from the Function Gallery or Configured Functions.
-
While associating a function from the gallery, click Save as New.
-
While associating a configured function, click Save or Save & Execute .
-
Once the functions are configured, click Save .
Prioritize custom function
- Navigate to the associated custom function in Blueprint/Business Rule and hover over it.
- Click more options and check Prioritize this function’s execution .
- Custom functions configured under Schedule Actions cannot be prioritized.
- Only one custom function per Instant Action block can be prioritized.
Delete custom function
-
Navigate to
-
Mouse over the function name you want to delete.
-
Click
-
Confirm your action.
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:
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.
Zoho Sheet Resources
Zoho Forms Resources
Zoho Sign Resources
Sign, Paperless!
Zoho TeamInbox Resources
Zoho DataPrep Resources
Design. Discuss. Deliver.
Related Articles
Custom Function: Create_Job
This custom function can be used to create a new card in any orchestration. It can also be configured to carry forward necessary field values from the former card to the latter. Business Scenario Helen is the head of Procurement Management in her ...Custom Function: Create_Ticket_in_Zoho_Desk
Zoho Desk is customer service software which allows you to address customer concerns. This custom function can be used to post a card as a ticket in Zoho Desk. Prerequisites Sign up for Zoho Desk and create a department. The ticket will be created ...Sample Custom Function for Zoho Sheet integration
Prerequisite User must have an account in Zoho Sheet and Qntrl User must configure a Connection to authorize the access of Zoho Sheet from Qntrl. Business Case Zylker Inc, a Pharma company, uses Qntrl to record and process their orders. Every time a ...Custom Function: Post_and_Update_Comments_in_Zoho_Desk
Zoho Desk is a customer service software which allows you to address customer concerns. This custom function can be used to add or update comments in Zoho Desk whenever they are added or updated in Qntrl. The comments will be added to the tickets ...REST API
Access Privilege API key can be generated only by the Organization Owner. An API key provides a one-time authentication for triggering API calls in Qntrl. Only the standalone custom functions can be invoked using the API key. Navigate to and ...