daren.hsu/webhook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add note about content type to README

Browse Source 
I noticed a few other people in the issues ran into the [same problem that I did](https://github.com/adnanh/webhook/issues/140) -- using the wrong Content Type and wondering why webhook payloads weren't coming through.  Indeed it seems that Github defaults to `application/x-www-form-urlencoded` which doesn't seem to work.

This PR adds a small note to the README to hopefully avoid others running into the same problem.

Cheers and thanks for devoting your time to this project!  It's been a huge help to me.
This commit is contained in:
Dave Cadwallader 2018-03-04 22:21:49 -07:00 committed by GitHub
parent 10396a5434
commit 1879edae91
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -72,6 +72,8 @@ Check [webhook parameters page](docs/Webhook-Parameters.md) to see how to overri
By performing a simple HTTP GET or POST request to that endpoint, your specified redeploy script would be executed. Neat!
_Note_: Be sure to send the webhook body using `Content type: application/json`. Using other content types won't work.
However, hook defined like that could pose a security threat to your system, because anyone who knows your endpoint, can send a request and execute your command. To prevent that, you can use the `"trigger-rule"` property for your hook, to specify the exact circumstances under which the hook would be triggered. For example, you can use them to add a secret that you must supply as a parameter in order to successfully trigger the hook. Please check out the [Hook rules page](docs/Hook-Rules.md) for detailed list of available rules and their usage.
## Templates