Referencing Request Values

Referencing request values

There are three types of request values:

1. HTTP Request Header values

   {
     "source": "header",
     "name": "Header-Name"
   }

2. HTTP Query parameters

   {
     "source": "url",
     "name": "parameter-name"
   }

3. Payload (JSON or form-value encoded)

   {
     "source": "payload",
     "name": "parameter-name"
   }

   Note: For JSON encoded payload, you can reference nested values using the dot-notation. For example, if you have following JSON payload

   {
     "commits": [
       {
         "commit": {
           "id": 1
         }
       }, {
         "commit": {
           "id": 2
         }
       }
     ]
   }

   You can reference the first commit id as

   {
     "source": "payload",
     "name": "commits.0.commit.id"
   }

   If the payload contains a key with the specified name "commits.0.commit.id", then the value of that key has priority over the dot-notation referencing.

If you are referencing values for environment, you can use envname property to set the name of the environment variable like so

{
  "source": "url",
  "name": "q",
  "envname": "QUERY"
}

to get the QUERY environment variable set to the q parameter passed in the query string.

Special cases

If you want to pass the entire payload as JSON string to your command you can use

{
  "source": "entire-payload"
}

for headers you can use

{
  "source": "entire-headers"
}

and for query variables you can use

{
  "source": "entire-query"
}