article How to use the Raw API Request blocks in Qlik Automate in Official Support Articles

How to use the Raw API Request blocks in Qlik Automate

Emile_Koslowski — Fri, 15 Aug 2025 05:26:30 GMT

This article explains how the Raw API Request blocks in Qlik Automate can be used.

Most connectors in Qlik Automate have a Raw API Request and a Raw API List Request block that can make an API call to an API resource of your choosing. These blocks will use the connection's account and credentials.

Before using these blocks, you should read the API documentation and test the call you want to make in cURL, Postman, or a similar tool.

Below is a detailed overview of these two blocks and how they should be used:

Raw API Request

Path
This block will make an API call to the connector's base URL + a path specified in the "Path" input parameter, such as https://hubspot.com/api/v1/ + users. The connector's base URL is hard-coded in each block implementation.

Note: Do not specify any query parameters in the Path parameter. Use the Query Parameters input field instead.

Method
The next parameter is the method that should be used to request the full URL. This can be one of the following methods: GET/POST/PUT/PATCH/DELETE.

Body Parameters
The Body Parameters input field allows you to build an object of key-value pairs. This object will be converted to a JSON object and will be sent as a body parameter with the request.

Query Parameters
The Query Parameters input field will work similarly to the Body Parameters input field. Except that the final object will be transformed to a query string of the format &key1=value1?key2=value2 and URL encoding will be applied.

See the Raw API Request block of the Qlik Cloud Services connector below as an example:

Raw API List Request

To retrieve a list of records (that exists out of multiple pages), use the block Raw API List Request. This block has built-in paging so no manual paging with the query parameters is required.

This block will work similarly to the Raw API Request block, except for the method, which will be a GET request in all connectors.

See the Raw API List Request block of the Qlik Cloud Services connector below as an example:

Limitations

There are three limitations for the Raw API Request block:

The block does not implement pagination.
It is not possible to send empty values in the key-value pair of an object in the body parameter. This is due to UI limitations.
The block is configured with GET as the default method, even if its changed during execution, the platform still logs the default GET method.

The information in this article is provided as-is and to be used at own discretion. Depending on tool(s) used, customization(s), and/or other factors ongoing support on the solution below may not be provided by Qlik Support.

Re: How to use the Raw API Request blocks in Qlik Application Automation

igorgois_ — Thu, 14 Oct 2021 02:07:23 GMT

Great tutorial!

Question: is it possible to use the data-alerts [1] or web-notifications [2]?

I am trying to get a qlik alert result and send it in a slack/teams

I only managed to use the APIs that are in the list:

Available APIs are:

Thanks in advance

[1] https://qlik.dev/apis/#rest-api-data-alerts

[2] https://qlik.dev/apis/#rest-api-web-notifications

Re: How to use the Raw API Request blocks in Qlik Application Automation

Emile_Koslowski — Thu, 14 Oct 2021 15:07:14 GMT

Thanks for the feedback!

We are working on an update to the Raw API Request blocks, this will include data-alerts and web-notifications.

Emile

Re: How to use the Raw API Request blocks in Qlik Application Automation

matsseverin — Wed, 09 Feb 2022 16:02:23 GMT

Hi,

Can you please show us an example of using the DELETE method in the Raw API Request block?

I have been trying to use the DELETE method of the Raw API Request block, in combination with the Qlik "Items" API, without any success. More specifically, I'm trying to delete data files in a space.

In the first step I'm using the Raw API List Request to list items (path = items) in a space with the resourceType = dataset. That gives me a list of the qvd's in that space. So far so good.

In the second step I use the Raw API request and the DELETE method, where I use the path = items/{item id}, where item id is based on the list of item ids in the first step.

That seemingly delete the files when I look in the space, but when I go into the space settings and the Data Sources view, the files are still there? Is this a known issue or am I missing something in my automation blocks?

Thanks,

Mats

Re: How to use the Raw API Request blocks in Qlik Application Automation

Emile_Koslowski — Thu, 10 Feb 2022 09:46:32 GMT

Hi Mats,

Here's an example of a DELETE method on the Items API to delete a file:

I get the same behavior as you when I execute the above automation, the file is removed from the catalog but still visible in the space's settings.

I'll raise this with the Items API team. But keep in mind that the DELETE endpoint of the Items API is marked as experimental, so it's best not to use it until it becomes stable.

Kind regards,
Emile

Re: How to use the Raw API Request blocks in Qlik Application Automation

FrankGrimm — Tue, 31 May 2022 07:58:39 GMT

Thanks for this tutorial,

this are my first steps in application automation.

I need to send a API Request to an external supplier.

The needed API is:

https://{current_QCS_tenant_url}/api/{path...

The API request in the block

RAW API REUQEST is

https://{current_qcs_tenant_url}/api/v1/{path......

Whats about the v1?

Thank you!

Frank

Re: How to use the Raw API Request blocks in Qlik Application Automation

Emile_Koslowski — Tue, 31 May 2022 08:04:16 GMT

Hi Frank,

Can you share a link to the API docs of the endpoint you'd want to call here?

Emile

Re: How to use the Raw API Request blocks in Qlik Application Automation

p_verkooijen — Fri, 20 Jan 2023 09:38:06 GMT

Hi @Emile_Koslowski I am trying to setup this webhook

https://developer.teamwork.com/guides/teamwork-chat-incoming-hooks/post-data-using-incoming-hooks/

Should be quite simple, Postman works

However I keep getting an error when using it from Automations

Test url = https://chat-hooks.eu.teamwork.com/v1/in/460616/fa9b4fce-b643-4ad9-bfd8-46c8ae4083ae

What am I doing wrong?

Re: How to use the Raw API Request blocks in Qlik Application Automation

Sonja_Bauernfeind — Mon, 30 Jan 2023 07:32:14 GMT

Hello @p_verkooijen

Any chance you could post this over in our Automation forums to get our active engineers engaged on this (or, if this fails, a ticket may be required).

All the best,
Sonja

Re: How to use the Raw API Request blocks in Qlik Application Automation

p_verkooijen — Mon, 30 Jan 2023 07:57:35 GMT

@Sonja_Bauernfeind done https://community.qlik.com/t5/Qlik-Application-Automation/How-to-create-a-POST-using-Raw-API-Request-block/td-p/2031332

Re: How to use the Raw API Request blocks in Qlik Application Automation

Sonja_Bauernfeind — Mon, 30 Jan 2023 08:21:54 GMT

@p_verkooijen

Thanks!

Re: How to use the Raw API Request blocks in Qlik Application Automation

p_verkooijen — Mon, 30 Jan 2023 09:21:06 GMT

@Sonja_Bauernfeind seems I had to use the Call URL block instead

Re: How to use the Raw API Request blocks in Qlik Application Automation

Sonja_Bauernfeind — Mon, 30 Jan 2023 09:48:51 GMT

@p_verkooijen Glad you got a quick answer to this! I'll see if we need to update this article.

All the best,
Sonja

Re: How to use the Raw API Request blocks in Qlik Application Automation

FahadAbdu — Wed, 23 Aug 2023 18:29:30 GMT

Is it possible to use the Raw API Request blocks to post apps from one space to another/publish to managed spaces based on specific tags?

Re: How to use the Raw API Request blocks in Qlik Application Automation

Sonja_Bauernfeind — Mon, 28 Aug 2023 06:55:45 GMT

Hello @FahadAbdu

I recommend posting about your query in the Qlik Application Automation forum. Provide details for your requirement and use case so that our user base and support agents can assist you best.

All the best,
Sonja

Re: How to use the Raw API Request blocks in Qlik Application Automation

LiorT — Tue, 05 Sep 2023 07:00:05 GMT

hello

Thanks for this tutorial,

I would be happy to consult with you.

Suppose I have a SHEET, there is a table with about 5 fields and it has 6000 records.
I want to upload all 6000 customers in an API interface to my other system, of course JSON.
My system knows how to receive a list of a maximum of 4000 customers each time. If I am currently using this block, then I get an error because he tried to load all 6000 from STRAIGHT TABLE, (only 4000 are possible at a time)
How can I loop? Or what is the solution to upload up to 4000 records each time? I would appreciate your assistance !

Re: How to use the Raw API Request blocks in Qlik Application Automation

Sonja_Bauernfeind — Mon, 11 Sep 2023 11:35:25 GMT

Hello @LiorT

Please post your query and requirements directly in our Qlik Application Automation forum for more assistance.

All the best,
Sonja

Re: How to use the Raw API Request blocks in Qlik Automate

muhammadraza — Tue, 11 Nov 2025 14:41:53 GMT

How to add custom headers in the request? E.g referer:https://xyz.com, x-qlik-xrfkey:RdcQbciyNQI9QzDN etc?

Re: How to use the Raw API Request blocks in Qlik Automate

paulcalvet — Tue, 07 Apr 2026 13:27:45 GMT

Hello @Emile_Koslowski

I try to use this block with Qlik answer.

I always receive an error 500.

Do you know what is not good in my query ?

Thanks.