invokeUrl task
In a nutshell
The invokeUrl task allows you to make API calls and interact with external services directly within a web test case, without leaving the testing environment. It supports calling web resources, accessing other Zoho services via their APIs, and connecting to third-party services using QEngine connections for secure authentication. This makes it possible to automate end-to-end workflows where frontend actions in the browser need to trigger or validate backend operations across multiple systems.
The invokeUrl task allows you to make API calls and interact with external services directly within a web test case, without leaving the testing environment. It supports calling web resources, accessing other Zoho services via their APIs, and connecting to third-party services using QEngine connections for secure authentication. This makes it possible to automate end-to-end workflows where frontend actions in the browser need to trigger or validate backend operations across multiple systems.
1. Overview
In modern testing, web interactions rarely occur in isolation; tests often need to interact with APIs, manipulate data, or trigger other systems to reflect real-world workflows. The invoke Url task in Zoho QEngine bridges this gap, letting you integrate API calls and external operations directly into their web test cases. It lets you access web resources, communicate with other Zoho services via their APIs, or work with third-party services securely.
Zoho QEngine’s connections provide a safe and reliable mechanism for authentication and authorization, ensuring every API call is executed securely. With Invoke URL, you can orchestrate complex sequences, automate backend and frontend workflows, and execute multi-system scenarios, all from a single testing environment. This enables end-to-end automation and ensures tests mirror real-world use cases efficiently and reliably.
Notes:
- Public web resources do not require authentication, so you can call them directly.
- This task will throw "socket timeout error" if the web resource/API takes more than 60 seconds to respond. This means that the task will be terminated, and you need to wait for a few moments before trying again.
- Any API that is private, whether it’s a Zoho service or third-party, must use a Connection to handle authentication securely.
- The default connection timeout will happen in 10 seconds, and the connection request timeout in 5 seconds.
- This task can download files up to 5 MB.
1.1 Syntax
- <response> = invokeUrl
- [
- url: <url_value>
- type: <type_value>
- headers: {<headers_value>}
- parameters: {<parameters_value>}
- connection: "<connection_name>"
- ];
Parameter | Description |
<response> | The variable that stores the response of the invoke URL call. |
<url_value> | The endpoint URL to which the request is sent. Can be a web resource, another Zoho service API, or a third-party API. |
<type_value> | The HTTP method for the request. Supported values:
|
<headers_value> (optional) | Contains HTTP headers to be sent with the request. Headers let you define authentication details, content preferences, and request conditions. |
<parameters_value> (optional) | The data sent in the request body for POST/PUT/PATCH requests. If you pass a plain text value, it is treated as Raw, and the body is sent exactly as defined. If you pass key–value pairs, it is automatically treated as x-www-form-urlencoded, where both keys and values are URL-encoded (for example, a space becomes %20). This format resembles a query string but is placed in the request body instead of the URL. |
<connection_name> (optional) | The connection link name of the required service. To use this, you must first create a connection in Zoho QEngine with the necessary authentication and request details. Once created, the connection is identified by its link name, which you reference here to authorize the invokeUrl call. For detailed steps on creating and managing connections, see Connections |
2. Using invoke Url in Zoho QEngine
Use Case: Pull User Data to Automate Dependent Test Steps
In this example, we'll fetch the list of users from the Zoho QEngine portal named Zylker. The QEngine API call is made within the script to pull live portal data that can drive subsequent test actions. For example, fetching the latest user list before assigning test roles, validating user availability, or applying conditions based on user details. By retrieving this data through the API, your test scripts stay adaptive and always reflect the current state of the portal.
To do this, we first create a connection in QEngine, which securely links the portal to its API. The connection provides a link name, which we use in our GET request to identify and authenticate the portal when fetching the user list.
- response = invokeUrl
- [
- url:"https://qengine.zoho.com/api/v1/zylker/myusers"
- type: GET
- connection:"qengine"
- ];
- info(response);
where:
response | Stores the API response, which contains the user details of the portal. |
QEngine’s REST API endpoint for fetching users in the Zylker portal. Learn more | |
GET | The HTTP method used to retrieve the records. |
"qengine" | The connection link name authorized with QEngine. |
3. Examples
Example 1: Automating Client Record Creation
This script demonstrates how to create a new client record in Zoho Recruit using its API. While users could manually add a client via the Zoho Recruit UI, doing so via a script is essential when you need to automate repetitive tasks, create multiple records in bulk, or integrate client creation into a larger test flow. To do this, you first establish a connection to Zoho Recruit, which provides the authentication required to invoke the API. Using this connection, the script sends the client details, making it easier to automate record creation.
- client_payload = {
- "data": [{
- "Client_Name": "Zylker Group",
- "Billing_City": "Keralabank",
- "Billing_State": "Kerala",
- "Billing_Country": "India",
- "Contact_Number": "74*******5",
- "Industry": "Television",
- "Source": "Meetup",
- "Website": "https://www.zylkergroup.com/about-us.html",
- "Territories": "T1"
- }]
- };
- // 2. Call the API via invokeurl
- response = invokeurl
- [
- url: "https://recruit.zoho.com/recruit/v2/Clients"
- type: POST
- parameters: client_payload.toString()
- connection: "recruit"
- ];
- // 3. Log the response
- if(response.isFile()){
- info(response.getFileContent());
- }else{
- info(response.isFile());
- }
where,
client_payload | The data you are sending to Zoho Recruit API. It contains the values for the new record and must be formatted according to the API documentation to ensure the request is processed correctly. |
This URL defines where the data is sent and ensures that your API call reaches the clients module in Zoho Recruit. | |
POST | HTTP request method specifying the action. |
client_payload.toString() | The data sent in the request body. The toString() is a built-in function that converts the JSON object into a string so it can be sent in the API request. |
"recruit" | The name of the connection. |
4. Related links
5. What's next
Next step
Next step
You’ve learned how to use the invokeUrl task in test cases to make HTTP requests, fetch data, and integrate APIs securely in Zoho QEngine.
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:
Centralize Knowledge. Transform Learning.
All-in-one knowledge management and training platform for your employees and customers.
New to Zoho Writer?
Create. Review. Publish.
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
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.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
for each task
In a nutshell The for each task repeats a defined set of actions for every entry in a collection, eliminating the need to duplicate steps when the same operations need to run across multiple records. It works with collections defined directly in the ...Configuring Zia for Zoho QEngine
What does this page cover Learn how to configure an AI model for Zia, Zoho QEngine's AI assistant, to enable capabilities such as generating manual test cases and test data. This page explains how to set up Zoho GenAI or connect external AI models ...Introduction to Zoho QEngine
In a nutshell Zoho QEngine is a unified test automation platform for your entire testing lifecycle. From test creation and management to execution and reporting, everything lives in one workspace. It supports cross-platform testing across web, ...concat()
In a nutshell The concat() function takes a source text and an append text as arguments and returns a single string formed by joining them together. The return type is Text. It is useful in test scripts where you need to combine two text values into ...trim()
In a nutshell The trim() function takes a string as an argument and returns the same string after removing all leading and trailing spaces. The return type is Text. It is useful in test scripts where you need to clean up text values before using them ...
New to Zoho LandingPage?
Zoho LandingPage Resources