Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Go-playground/webhooks
:fishing_pole_and_fish: Webhook receiver for GitHub, Bitbucket, GitLab, Gogs
https://github.com/Go-playground/webhooks
bitbucket github gitlab webhooks
Last synced: 4 months ago
JSON representation
:fishing_pole_and_fish: Webhook receiver for GitHub, Bitbucket, GitLab, Gogs
- Host: GitHub
- URL: https://github.com/Go-playground/webhooks
- Owner: go-playground
- License: mit
- Created: 2015-10-25T17:38:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-08-06T17:04:34.000Z (7 months ago)
- Last Synced: 2024-10-23T01:16:42.448Z (4 months ago)
- Topics: bitbucket, github, gitlab, webhooks
- Language: Go
- Homepage:
- Size: 579 KB
- Stars: 953
- Watchers: 20
- Forks: 238
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Library webhooks
================
[](https://github.com/go-playground/webhooks/actions)
[](https://coveralls.io/github/go-playground/webhooks?branch=master)
[](https://goreportcard.com/report/go-playground/webhooks)
[](https://godoc.org/github.com/go-playground/webhooks/v6)
Library webhooks allows for easy receiving and parsing of GitHub, Bitbucket, GitLab, Docker Hub, Gogs and Azure DevOps Webhook Events
Features:
* Parses the entire payload, not just a few fields.
* Fields + Schema directly lines up with webhook posted jsonNotes:
* Currently only accepting json payloads.
Installation
------------Use go get.
```shell
go get -u github.com/go-playground/webhooks/v6
```Then import the package into your own code.
import "github.com/go-playground/webhooks/v6"
Usage and Documentation
------Please see http://godoc.org/github.com/go-playground/webhooks/v6 for detailed usage docs.
##### Examples:
```go
package mainimport (
"fmt""net/http"
"github.com/go-playground/webhooks/v6/github"
)const (
path = "/webhooks"
)func main() {
hook, _ := github.New(github.Options.Secret("MyGitHubSuperSecretSecret...?"))http.HandleFunc(path, func(w http.ResponseWriter, r *http.Request) {
payload, err := hook.Parse(r, github.ReleaseEvent, github.PullRequestEvent)
if err != nil {
if err == github.ErrEventNotFound {
// ok event wasn't one of the ones asked to be parsed
}
}
switch payload.(type) {case github.ReleasePayload:
release := payload.(github.ReleasePayload)
// Do whatever you want from here...
fmt.Printf("%+v", release)case github.PullRequestPayload:
pullRequest := payload.(github.PullRequestPayload)
// Do whatever you want from here...
fmt.Printf("%+v", pullRequest)
}
})
http.ListenAndServe(":3000", nil)
}```
Contributing
------Pull requests for other services are welcome!
If the changes being proposed or requested are breaking changes, please create an issue for discussion.
License
------Distributed under MIT License, please see license file in code for more details.