mirrors/webhook
1
0
Fork 0
mirror of https://github.com/adnanh/webhook.git synced 2025-06-24 13:28:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: add new hook option keep-file-environment

Browse source
This commit is contained in:
jason.liao 2023-07-25 13:58:53 +08:00
parent f187592147
commit fe539f46b5
3 changed files with 49 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/Hook-Definition.md
View file

@ -23,6 +23,7 @@ Hooks are defined as objects in the JSON or YAML hooks configuration file. Pleas
* `trigger-rule` - specifies the rule that will be evaluated in order to determine should the hook be triggered. Check [Hook rules page](Hook-Rules.md) to see the list of valid rules and their usage
* `trigger-rule-mismatch-http-response-code` - specifies the HTTP status code to be returned when the trigger rule is not satisfied
* `trigger-signature-soft-failures` - allow signature validation failures within Or rules; by default, signature failures are treated as errors.
* `keep-file-environment` - Keep all submitted files. Sending `curl -d 'pkg=@res.tar.gz'` will retrieve the environment variable `HOOK_FILE_PKG`, which contains the file path, and `HOOK_FILENAME_PKG`, which contains the file name as `res.tar.gz`. If `keep-file-environment` is true, the file will be preserved after the hook is executed. By default, the corresponding file will be removed after the webhook exits.
## Examples
Check out [Hook examples page](Hook-Examples.md) for more complex examples of hooks.