Mirrors/webhook
1
0
Fork 0
mirror of https://github.com/adnanh/webhook.git synced 2026-07-30 13:30:11 +00:00
Code Issues Projects Releases Wiki Activity

Updated Hook Definition (markdown)

Adnan Hajdarević 2015-06-06 14:36:10 +02:00
parent a1725d9207
commit 8b2850618d
1 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
Hook-Definition.md

@ -7,10 +7,11 @@ Hooks are defined as JSON objects. Please note that in order to be considered va
* `execute-command` - specifies the command that should be executed when the hook is triggered
* `command-working-directory` - specifies the working directory that will be used for the script when it's executed
* `response-message` - specifies the string that will be returned to the hook initiator
* `include-command-output-in-response` - boolean whether webhook should wait for the command to finish and return the output and/or error as a response to the hook initiator
* `parse-parameters-as-json` - specifies the list of arguments that contain JSON strings. These parameters will be decoded by webhook and you can access them like regular objects in rules and `pass-arguments-to-command`.
* `pass-arguments-to-command` - specifies the list of arguments that will be passed to the command. Check [Referencing request values page](Referencing-Request-Values) to see how to reference the values from the request. If you want to pass a static string value to your command you can specify it as
`{ "source": "string", "name": "argumentvalue" }`
* `trigger-rule` - specifies the rule that will be evaluated in order to determine should the hook be triggered. Check [Hook rules page](Hook-Rules) to see the list of valid rules and their usage
## Examples
Check out [Hook examples page](Hook-Examples) for more complex examples of hooks.
Check out [Hook examples page](Hook-Examples) for more complex examples of hooks.