GitHub webhook
curl --request POST \
--url http://localhost:3000/webhook/github \
--header 'Content-Type: application/json' \
--header 'x-hub-signature-256: <x-hub-signature-256>' \
--data '
{
"pull_request": {
"number": 123,
"head": {
"ref": "<string>",
"sha": "<string>",
"repo": {
"clone_url": "<string>",
"name": "<string>",
"owner": {
"login": "<string>"
}
}
},
"base": {
"ref": "<string>"
}
},
"repository": {
"full_name": "<string>",
"name": "<string>",
"owner": {
"login": "<string>"
}
}
}
'import requests
url = "http://localhost:3000/webhook/github"
payload = {
"pull_request": {
"number": 123,
"head": {
"ref": "<string>",
"sha": "<string>",
"repo": {
"clone_url": "<string>",
"name": "<string>",
"owner": { "login": "<string>" }
}
},
"base": { "ref": "<string>" }
},
"repository": {
"full_name": "<string>",
"name": "<string>",
"owner": { "login": "<string>" }
}
}
headers = {
"x-hub-signature-256": "<x-hub-signature-256>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-hub-signature-256': '<x-hub-signature-256>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
pull_request: {
number: 123,
head: {
ref: '<string>',
sha: '<string>',
repo: {clone_url: '<string>', name: '<string>', owner: {login: '<string>'}}
},
base: {ref: '<string>'}
},
repository: {full_name: '<string>', name: '<string>', owner: {login: '<string>'}}
})
};
fetch('http://localhost:3000/webhook/github', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/webhook/github",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pull_request' => [
'number' => 123,
'head' => [
'ref' => '<string>',
'sha' => '<string>',
'repo' => [
'clone_url' => '<string>',
'name' => '<string>',
'owner' => [
'login' => '<string>'
]
]
],
'base' => [
'ref' => '<string>'
]
],
'repository' => [
'full_name' => '<string>',
'name' => '<string>',
'owner' => [
'login' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-hub-signature-256: <x-hub-signature-256>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/webhook/github"
payload := strings.NewReader("{\n \"pull_request\": {\n \"number\": 123,\n \"head\": {\n \"ref\": \"<string>\",\n \"sha\": \"<string>\",\n \"repo\": {\n \"clone_url\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"login\": \"<string>\"\n }\n }\n },\n \"base\": {\n \"ref\": \"<string>\"\n }\n },\n \"repository\": {\n \"full_name\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"login\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-hub-signature-256", "<x-hub-signature-256>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/webhook/github")
.header("x-hub-signature-256", "<x-hub-signature-256>")
.header("Content-Type", "application/json")
.body("{\n \"pull_request\": {\n \"number\": 123,\n \"head\": {\n \"ref\": \"<string>\",\n \"sha\": \"<string>\",\n \"repo\": {\n \"clone_url\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"login\": \"<string>\"\n }\n }\n },\n \"base\": {\n \"ref\": \"<string>\"\n }\n },\n \"repository\": {\n \"full_name\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"login\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/webhook/github")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-hub-signature-256"] = '<x-hub-signature-256>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pull_request\": {\n \"number\": 123,\n \"head\": {\n \"ref\": \"<string>\",\n \"sha\": \"<string>\",\n \"repo\": {\n \"clone_url\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"login\": \"<string>\"\n }\n }\n },\n \"base\": {\n \"ref\": \"<string>\"\n }\n },\n \"repository\": {\n \"full_name\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"login\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "ok"
}{
"error": "<string>"
}{
"error": "<string>"
}Webhook
GitHub webhook
Receives GitHub pull_request webhook events (opened, reopened, synchronize, closed). Requires X-Hub-Signature-256 header. Payload follows GitHub webhook payload format.
POST
/
webhook
/
github
GitHub webhook
curl --request POST \
--url http://localhost:3000/webhook/github \
--header 'Content-Type: application/json' \
--header 'x-hub-signature-256: <x-hub-signature-256>' \
--data '
{
"pull_request": {
"number": 123,
"head": {
"ref": "<string>",
"sha": "<string>",
"repo": {
"clone_url": "<string>",
"name": "<string>",
"owner": {
"login": "<string>"
}
}
},
"base": {
"ref": "<string>"
}
},
"repository": {
"full_name": "<string>",
"name": "<string>",
"owner": {
"login": "<string>"
}
}
}
'import requests
url = "http://localhost:3000/webhook/github"
payload = {
"pull_request": {
"number": 123,
"head": {
"ref": "<string>",
"sha": "<string>",
"repo": {
"clone_url": "<string>",
"name": "<string>",
"owner": { "login": "<string>" }
}
},
"base": { "ref": "<string>" }
},
"repository": {
"full_name": "<string>",
"name": "<string>",
"owner": { "login": "<string>" }
}
}
headers = {
"x-hub-signature-256": "<x-hub-signature-256>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-hub-signature-256': '<x-hub-signature-256>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
pull_request: {
number: 123,
head: {
ref: '<string>',
sha: '<string>',
repo: {clone_url: '<string>', name: '<string>', owner: {login: '<string>'}}
},
base: {ref: '<string>'}
},
repository: {full_name: '<string>', name: '<string>', owner: {login: '<string>'}}
})
};
fetch('http://localhost:3000/webhook/github', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/webhook/github",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pull_request' => [
'number' => 123,
'head' => [
'ref' => '<string>',
'sha' => '<string>',
'repo' => [
'clone_url' => '<string>',
'name' => '<string>',
'owner' => [
'login' => '<string>'
]
]
],
'base' => [
'ref' => '<string>'
]
],
'repository' => [
'full_name' => '<string>',
'name' => '<string>',
'owner' => [
'login' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-hub-signature-256: <x-hub-signature-256>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/webhook/github"
payload := strings.NewReader("{\n \"pull_request\": {\n \"number\": 123,\n \"head\": {\n \"ref\": \"<string>\",\n \"sha\": \"<string>\",\n \"repo\": {\n \"clone_url\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"login\": \"<string>\"\n }\n }\n },\n \"base\": {\n \"ref\": \"<string>\"\n }\n },\n \"repository\": {\n \"full_name\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"login\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-hub-signature-256", "<x-hub-signature-256>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/webhook/github")
.header("x-hub-signature-256", "<x-hub-signature-256>")
.header("Content-Type", "application/json")
.body("{\n \"pull_request\": {\n \"number\": 123,\n \"head\": {\n \"ref\": \"<string>\",\n \"sha\": \"<string>\",\n \"repo\": {\n \"clone_url\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"login\": \"<string>\"\n }\n }\n },\n \"base\": {\n \"ref\": \"<string>\"\n }\n },\n \"repository\": {\n \"full_name\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"login\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/webhook/github")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-hub-signature-256"] = '<x-hub-signature-256>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pull_request\": {\n \"number\": 123,\n \"head\": {\n \"ref\": \"<string>\",\n \"sha\": \"<string>\",\n \"repo\": {\n \"clone_url\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"login\": \"<string>\"\n }\n }\n },\n \"base\": {\n \"ref\": \"<string>\"\n }\n },\n \"repository\": {\n \"full_name\": \"<string>\",\n \"name\": \"<string>\",\n \"owner\": {\n \"login\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "ok"
}{
"error": "<string>"
}{
"error": "<string>"
}Headers
HMAC-SHA256 signature of the request body using the webhook secret.
Example:
"sha256=..."
Body
application/json
GitHub pull_request webhook payload. See https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request
Response
Webhook processed successfully
Example:
"ok"
⌘I