Permalink
Browse files

document github webhooks

  • Loading branch information...
1 parent 2b2e354 commit 30292be7e2ca7297bfaebb539666e8b1c538a3b5 @obfuscurity committed Jul 23, 2012
Showing with 4 additions and 0 deletions.
  1. +4 −0 README.md
View
@@ -18,6 +18,10 @@ Backstop supports submission of metrics via the Collectd [write_http](http://col
</Plugin>
```
+### GitHub Post-Receive Hooks
+
+Backstop can receive commit data from GitHub [post-receive webhooks](https://help.github.com/articles/post-receive-hooks). Your WebHook URL should consist of the Backstop service URL with the `/github` endpoint. For example, `https://backstop.example.com/github`.
+
### Custom Metrics
Use the `/publish` endpoint in conjunction with one of the approved `PREFIXES` for submitting metrics to Backstop. In most environments it makes sense to use distinct prefixes for normal (e.g. gauge, counters, etc) metrics vs annotation (event-style) metrics.

0 comments on commit 30292be

Please sign in to comment.