pre-request scripts

[scollovati]

What about implementing a feature like this one https://learning.postman.com/docs/writing-scripts/pre-request-scripts/ ?

[dimitropoulos]

Could you please provide a use-case for what you'd use this for? What's something you'd like to do today with insomnia that you can't without a feature like this?

[zillou]

Calculating the request digest and signature is a quite common thing for API Key and API Secret based authentication.

[JuninhoFreitas]

I need to generate a payload that uses random uuidv4, names unically based in timestamp and other random datas,
then, i use the data created in environment to utilize others endpoints,
So, basically, what i needed was:
Send a request,
Use some parts of response in environment,
Use this environment to utilize another endpoin

[opctim]

Automatically perform a JWT login, fetch the token and attach it to the request body if not present or expired.

[lcsmobileqa]

I need to pre-format a date to use as the variable in multiple of my requests. This was a hugely useful feature in Postman and would be most welcome here. Being able to set the date/time format allowed our tests to automate hands-off from gitlab. Without it, we're having to manually update before running the collection. Thank you!

[morfidon]

I could stringify json for next api call that requires it stringified for example

[peronecode]

Dammit, here I am begging for this feature hahah.
It will be awesome to have this feature. What do you think @gschier?

If needs help to develop, I'm not into this code but I'm in. 🤘🏼

[dimitropoulos]

What is your use-case?

[peronecode]

Sorry my late answer peps, but I'm looking for a pre-request script execution, like we have in Postman. 🤓

Use-case: Before every single request, we can add a JavaScript (or any language) small logic script that suppose to run before the request.

e.g: Before my request, I would love to add a new custom hash generated to a new variable, and this is a JavaScript logic. So, after ran this script/code block/logic, my request will be sent using the updated variable that was updated over the pre-request script.

[Vagrantin]

Hello,
I’m also interested in this feature.
In my case I’m using pre-request script to populate variable before triggering the API call.
This is use full when triggering the API call several time and updating the variables before each call.
And my API call is more clean when there is lot’s of data in it.
Hope that helps.

[steelerc69]

My use case is to calculate a HMAC value from the body provided, before I send a request and populate a header value with it

[jquexxx]

hi chiming in here, my use-case is to insert unwanted characters during api call.

thanks.

[felipejsm]

Hi,
My use case is slightly different from the others
I use it to do a http request to get a token and use it as a header on other http request

[GleytonLima]

We need also a custom script after the request to extract and compare some fields to populate environment variables. Like the Test tab of Postman, for example.

[T2MWorks-Mitch]

sadly I will have to go back to postman without this feature in insomnia, as the postman API collections I import/use , leverage this feature for ading API keys to headers prior to each request

as a non developer i jsut dont have the bandwidth to figure out how to hack this together in Insomnia

[GleytonLima]

I made a solution using some custom plugins to get the same pre and post request handling functionality. I made a video, in portuguese, explaining how to use these features (https://youtu.be/NO8p_4vK1G4?t=591). But a pre and post request area built-in would be ideal.

[lookto]

This would be such a good feature. In my use-case i need to get an acess token for the route i'm trying to test.

[brpeterman]

I have the same use case. In Postman, I was using the pre-request script to cache an auth token in the environment, then populating the Authorization header from that environment variable. Whenever the token expired, the script would automatically retrieve a new one.

[naretini]

This solves your case : https://docs.insomnia.rest/insomnia/chaining-requests
Chain token request response to the final request Auth value.
Postman uses the pre-script concept, Insomnia has this chain requests, which is not identical, maybe limiting, but for the purpose of auth works.

[brpeterman]

Thank you! I'll give that a try.

[brpeterman]

Following up on this, request chaining is working really well already. I've placed the tag in an environment variable and each of my requests is pulling that variable in for the bearer token. Thanks for the tip!

[T2MWorks-Mitch]

@naretini - this does not actaully solve the case - I use this now for obtaining a token , but still have to run the acquire token command first. Postman has this functionalilty AND the ability to run the "acquire token" request automatically as part of the second request

[henrycorredor]

In our case, we create a sign with the CryptoJS library with a given string, extracted from some keys of the body. It seems that sign can be only made on the go when you make the post request.

[manhtranlinh]

In my case, I need to send JSON message and some attachments in one POST request by multipart-data/form option. But in case option is multipart-data/form, Insomnia will set JSON part as string and send to server, so that I have to decode this part. So that if has pre-request scripts or option to combine STRUCTURED/Multipart Form and TEXT/JSON is very comfortable.

[KikoCosmetics]

Hi!

Any news on this? I actually want to migrate from Postman, but I used pre-request scripts to generate headers for requests to AWS.
Without this I can't really move to Insomnia!

[DanielHilton]

I would also be very interested to have this feature.

My usecase is:
I need to generate a SHA256 checksum of several concatenated values from a request body along with a secret key. In Postman I can do this in a pre-request script, in Insomnia I cannot and must do it manually.

[iulianraduat]

@torian257x I accepted your challenge and I created an Insomnia plugin called "Custom Generated Value".

The solution was to define a new TemplateTag called "Custom Generated Value" which can be used in more than just request's body (try to insert it using ctrl+space to display the list of available tags).

The code for generated value is defined either directly in an environment variable (as an array of lines) or in a .js file (which has its name in the environment variable). You can see some examples in the README of this plugin.

Also it makes all defined environment variables available to your code via variable $$ so you can use them to build your result.

You can find it in the Insomnia's Plugin Hub at https://insomnia.rest/plugins/insomnia-plugin-custom-generated-value.

Please try it and let me know what you think.

Thanks,
Iulian

[vlcekr]

Hi, are there any plans to implement this feature please? Like for others, for me this is crucial feature too.

[JuninhoFreitas]

My Workaround:
Run a local api just to in response return the JSON body sent,
then, in environment, refer to the response of the mock api,
and create a folder with multiple cases that u will need, like, "pre-req auxiliar", "pre-req master", "pre-req x".

Code:
https://gist.github.com/JuninhoFreitas/d7a6ef58c45149d62dd0025951d96bc1

Only needs nodejs, to keep running in background, use pm2
e.g:
pm2 run index.js

My case:
I need to generate a payload that uses random uuidv4, names unically based in timestamp and other random datas,
then, i use the data created in environment to utilize others endpoints,
So, basically, what i needed was:
Send a request,
Use some parts of response in environment,
Use this environment to utilize another endpoint.

[sebastianbuechler]

To be honest, this was the reason why we switched to postman. No need for workarounds or custom solutions. It's just there and working.

[subnetmarco]

Many changes are coming to Insomnia and as soon as we implement SSE (currently being worked on) I am eying this capability next.

[sebastianbuechler]

Thanks for the response @subnetmarco. Just wanted to give some information about why we switched. I still like the approach of Isnomnia, but that was a deal-breaker. Maybe we'll evaluate it in the future again.

[hbertsch]

We also are using Postman for the same reason. However they will move their product entirely to the cloud. We will not be allowed to use this product... Its a shame

[NickRimmer]

The most challenging part will be not creating a plugin with input for JS and even not about how to run it before request. But what should this script be for? Changing of variables in request? Replace/Inject body? Build/Update the request URL? I think the most difficult part will be to add access for a script to Insomnia world, as Insomnia provided very limited access to application variables/methods even for plugins

[hbertsch]

The pre-request feature is a critical functionality that we would require in Insomnia, similar to what is available in Postman. This feature is one of the major advantages of Postman, and we heavily rely on it in our collections. However, since Postman has transitioned to a full cloud-based platform, we are no longer able to use it due to compliance and security concerns. It is not feasible for us to store our company's API details and scripts on a third-party cloud server.

As a result, we are actively searching for an alternative tool, and Insomnia appears to be a promising option. However, the absence of the pre-request feature in Insomnia is a significant drawback for us and could potentially hinder us from using it. This feature is essential because we have a variety of logic that must be executed before and after certain requests, such as setting environment variables, hashing data, and generating payloads. Without this capability, our testing process would be severely impacted.

[iulianraduat]

Friendly reminder:
I had a similar problem and hence I created an Insomnia plugin called "Custom Generated Value". Until an official solution is provided, I think that this plugin can solve a lot of use cases. You can even make feature requests if you need something added to this plugin.

You can find more details in my post from Feb 25

Thanks,
Iulian

[JPPereira123]

Same here.. We're currently doing a proof-of-value on Postman vs Insomnia enterprise options for hundreds of seats, and even though Insomnia overall looks quite promising, not having similar pre/post-req script capabilities seems like quite a deal breaker for us.

[subnetmarco]

Update: we are currently allocating resources to work on this issue, we will post more updates once we have a better idea on the timeline.

[JuninhoFreitas]

God Heard the People!
Thanks Marco!

[DanielHilton]

many thanks @subnetmarco i looks forward to hearing progress 🙏🏻

[JPPereira123]

Thank you Marco.

Just a heads up so you don't run into the same experience we have with Postman: approving pre/post request script PRs via github is very bad UX as Postman formats the scripts in a very text/json unreadable manner. I'd recommend investigating ways to execute plain js/ts files so they can be stored and reviewed as usual.

[caseyfw]

I concur with this - it would be ideal if there was a mechanism to have these scripts live in actual JS files rather than JS embedded in JSON like Postman's solution.

All of our PRs to workflow updates look like this, and they're impossible to lint/review/edit/etc:

[subnetmarco]

Makes sense, easier to debug when the scripts are not embedded elsewhere. We will see what we can do (+ @ihexxa ).

[subnetmarco]

Update: we are making progress here, we may push this capability in beta in early February.

Bonus point: we have introduced a compatibility layer with Postman's SDK, so the same code can run in Insomnia with little or no modification.

[khirasoft]

Cool! Where can I sign in for the beta?
Also one additional question: Will it be possible to include other libs like crypto-js for example?

[guddu2112]

Thanks !!! We are also looking for this feature eagerly. let us know if there is a beta available already for observation feedback.

[subnetmarco]

I will be sharing a video soon, we may enable it in beta this month, this feature is quite large so there is a big ongoing review as we speak.

[subnetmarco]

Here is a preview video of pre-request scripting that we are building:

📹 https://www.loom.com/share/9e6f1253f8ca48bca49788f94fde8063

You can see how to:

1. Create a script inside Insomnia.
2. Manipulate environments from within a script.
3. Send requests and access responses.
4. Require modules for more advanced use-cases.
5. Logging for debugging and more.
6. Compatibility with no modifications with Postman scripts. by providing a pm.* alias that simply points to insomnia.* and implements the same interfaces (!). This will simplify migration from Postman.

We want to ship a preview of this capability ideally this month.

[subnetmarco]

We are planning to ship a beta closer by end of month, with GA sometime next month.

[ShakedAharonn]

Hi, is the beta already out?
Is it possible to join it? and if not any estimation to when the GA will be available?

[subnetmarco]

Hello, I will share a link to a beta distribution later this week. This capability ships this month.

[TomaszPanek]

Any updates about this @subnetmarco ?

[subnetmarco]

@TomaszPanek see the latest update on this discussion.

[subnetmarco]

The beta release with pre-request scripting is out!

You can download it at https://github.com/Kong/insomnia/releases/tag/core%409.0.0-beta.1

With this new release you will see a new "Pre-request Script" tab in the collection view, where you can create scripts:

• This is a beta feature and we are looking for feedback for improvements. Please send your feedback so we can incorporate it before GA: bugs, improvements or missing compatibility with Postman.
• The insomnia. object can also be consumed with pm.*, they are equivalent.
• The goal is to fully provide Postman compatibility for most of their API, so feel free to try and let us know if there is an API that is missing in Insomnia. We know a couple are missing, but we first want to see if the community cares about those.

[ihexxa]

The issue is fixed in #7172 and theoretically will be included in the next release.

[AleksandrZHANG]

We need Base64 key generation using CryptoJS while it seems not defined

[ihexxa]

Hi @AleksandrZHANG, this is expected as it is also a part of the above change and in review.

[ihexxa]

@deepanshuds @AleksandrZHANG In case you missed it, external modules are available in the latest beta4 version: https://github.com/Kong/insomnia/releases/tag/core%409.0.0-beta.4

[rickseven]

Hi @ihexxa, I have installed latest beta4 version, I need "crypto" module in my case but it seems not defined.

[subnetmarco]

A new beta version has been released with notable improvements to the pre-request scripting capability: https://github.com/Kong/insomnia/releases/tag/core%409.0.0-beta.3

We have another couple of known improvements that we want to make, before releasing it as GA in the next few weeks.

[solorisx]

Hi @ihexxa
(deleted my earlier comment - did not mean to create a top level comment)
By post-request scripts, you mean what Postman calls "Tests"?

That would certainly help - but what I meant was the ability to do
something in a test like:

insomnia.set_variable("variable_name", value);
const response = await insomnia.send();
// assertions here

This would save us from having to create dedicated requests for each test
where we want to verify the response. I think issue #3218 talks about the
same thing.

[misaya98]

for enterprise user, when we can get the pre-requst-script feature ?

[ihexxa]

@misaya98 It will be released in this month, and one or more beta version(s) will be released before that.

[deepanshuds]

Hi @ihexxa,
I tried to import a request from POSTMAN which has variables defined in pre-script and it failed to run in Insomnia. It throws an error 'The request failed due to an unhandled error: Error: attempted to output null or undefined value'.

var tempVar = "test" + _.random(1,1000000);
pm.environment.set("tempVar", tempVar);
var id = "ABC" + tempVar
pm.environment.set("id", id);

The issue is with using variables, it works fine if I hardcode the value of the variable.

Also, if I do not define the same variables as part of my environment variables and try to use them as part of the request body, it is unable to identify the variable. Would it be possible for the body to read the variables defined in pre-request scripts once it's defined there?

[ihexxa]

Hi @deepanshuds , thanks for the feedback. Ah I'm not able to reproduce it, would you mind to share one minimal export for reproducing it? Please check if all variables in url, body, auth, headers are defined. Probably you could also try conole.log to debug it.

And for the second question, nope.. currently it does not predict if the variable defined in the script. Script's result could depend on actions like sendRequest, so there seem no simple way to quickly predict it.

[subnetmarco]

Habemus pre-request scripting!

The new version of Insomnia 9.0 has been shipped with pre-request scripting available in the collections among many other features.

We will now work towards enabling post-request scripting which should ship in approximately one month, in the meantime let us know if there are any improvements you would like to see in pre-request scripting and we will address them in the next releases.

Known gaps that will be solved shortly in the next releases are:

• The globals environment variables SDK is not supported because we need to introduce first the concept of global environment variables in the product, which we also will ship shortly.
• The support for iteration data, we need to introduce support for selecting a local file and then make it available in the scripting SDK.

I will close this discussion for now.

[savoygrizzly]

Awesome ! Will it be possible to use some sort of basic require/import to at least have some default libs built-in ? I tried using Crypto with the same exact use case as the one that started this thread, couldn't import it or use it. Postman provides the deprecated CryptoJS by default I think. However having the latest standard one would be best I guess.

[ihexxa]

Hi @savoygrizzly, thanks for the feedback. Actually crypto-js should be part of the built-in libs but there was an issue in importing it, fixed in #7315 and will be included in the next minor release 9.1.

[ShakedAharonn]

Hi,
Thank you for adding support for the pre-request script!
Is there support for top level pre request script?
Or do you need to define it for every request?

my use-case - generating 1 time token from a const secret. this token is required for each api (i have about 30)

[subnetmarco]

We will support folder-level scripting in the next minor release, and afterwards collection-level scripting as well.

[ShakedAharonn]

Thank you, any estimation on when this will happen?

[subnetmarco]

@ShakedAharonn it should already be available in the latest 9.3 beta. We are planning a GA sometime next week.

[ShakedAharonn]

hi @subnetmarco
Seems like 9.3 is officially out, but when i try to use folder level scripting it doesn't seem to work. couldn't find anything in the release doc or documentation. Do you know the status? should it work on 9.3?

[subnetmarco]

I wanted to let you know that we have also completed the beta for post-request scripting (or after response scripting). More info at #6242 (comment)