webhook/docs/Referencing-Request-Values.md

Referencing request values

There are four types of request values:

1. HTTP Request Header values

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

2. HTTP Query parameters

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

3. HTTP Request parameters

   {
     "source": "request",
     "name": "method"
   }
   

   {
     "source": "request",
     "name": "remote-addr"
   }
   

4. 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.

5. XML Payload

   Referencing XML payload parameters is much like the JSON examples above, but XML is more complex. Element attributes are prefixed by a hyphen (-). Element values are prefixed by a pound (#).

   Take the following XML payload:

   <app>
     <users>
       <user id="1" name="Jeff" />
       <user id="2" name="Sally" />
     </users>
     <messages>
       <message id="1" from_user="1" to_user="2">Hello!!</message>
     </messages>
   </app>
   

   To access a given user element, you must treat them as an array. So app.users.user.0.name yields Jeff.

   Since there's only one message tag, it's not treated as an array. So app.messages.message.id yields 1.

   To access the text within the message tag, you would use: app.messages.message.#text.

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"
}