Step: Web Request

The Web Request step sends data from the package to a remote location on the internet. Options include GET, POST/PUT, and DELETE. Variables can be assigned to collect information returned from the remote server and to collect any response codes.


Can use table variable values

Allows FreeMarker Expressions

  • Source: Choose from one of your Data Sources of type "Web"
  • Path to Query: any path items to complete the URL you wish to send. FreeMarker Expressions will be converted to their values before sending.
  • Request Type: Choose from GET (all data in URL), POST (data in Message Body and appended on server), PUSH (same as POST but replaced on server), or DELETE (same as POST but deleted on server).
  • Below the path is a read-only preview of the URL the step will send. This is a combination of the URL in the Data Source, and the contents of the query path. As noted above, any FreeMarker Expressions will be converted into their values before sending.
  • Message Body: The variables and values or other data the step should send to the server. Not applicable with GET requests. To send the entire DarkLight package (to another DarkLight's HTTP POST Data Feed) enter ${packageAsJSON()}
  • Output Code Variable: A package variable name to store the code returned from the server (e.g. 404 Not Found, 200 OK, etc.)
  • Output Variable: A package variable name to store any returning data from the server.
  • Headers: The Content-Type parameter defaults to "application/json". Other common Content-Types include:
    • application/javascript
    • application/json
    • application/ld+json
    • application/octet-stream
    • application/xhtml+xml
    • application/xml
    • multipart/alternative
    • multipart/mixed
    • multipart/related
    • text/csv
    • text/html
    • text/plain
    • text/xml
  • Add a new header: Additional free-form headers can be added as required by your web server. Click in an empty row of the table and enter in the Key and Value. You can use FreeMarker expressions for the values in your header. As you add new items, additional rows will appear.
  • Remove a header: Click the red x icon to remove that row.

Great site for testing

A great place to test the Web Request step is httpbin.org. You can send requests to them and they will send you back responses that you can check with the Inventory view or a Save Package step.
  • step/web-request
  • Last modified: 2019/03/29 23:51