Webhook endpoint called by GitHub on events related to Cantina GitHub App.
curl --request POST \
--url https://api.example.com/api/v0/companies/github/webhook \
--header 'Content-Type: application/json' \
--data '
{
"installation": {
"id": 1,
"target_type": "<string>"
},
"account": {
"avatar_url": "<string>",
"html_url": "<string>",
"login": "<string>"
},
"changes": {
"login": {}
}
}
'import requests
url = "https://api.example.com/api/v0/companies/github/webhook"
payload = {
"installation": {
"id": 1,
"target_type": "<string>"
},
"account": {
"avatar_url": "<string>",
"html_url": "<string>",
"login": "<string>"
},
"changes": { "login": {} }
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
installation: {id: 1, target_type: '<string>'},
account: {avatar_url: '<string>', html_url: '<string>', login: '<string>'},
changes: {login: {}}
})
};
fetch('https://api.example.com/api/v0/companies/github/webhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v0/companies/github/webhook",
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([
'installation' => [
'id' => 1,
'target_type' => '<string>'
],
'account' => [
'avatar_url' => '<string>',
'html_url' => '<string>',
'login' => '<string>'
],
'changes' => [
'login' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "https://api.example.com/api/v0/companies/github/webhook"
payload := strings.NewReader("{\n \"installation\": {\n \"id\": 1,\n \"target_type\": \"<string>\"\n },\n \"account\": {\n \"avatar_url\": \"<string>\",\n \"html_url\": \"<string>\",\n \"login\": \"<string>\"\n },\n \"changes\": {\n \"login\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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("https://api.example.com/api/v0/companies/github/webhook")
.header("Content-Type", "application/json")
.body("{\n \"installation\": {\n \"id\": 1,\n \"target_type\": \"<string>\"\n },\n \"account\": {\n \"avatar_url\": \"<string>\",\n \"html_url\": \"<string>\",\n \"login\": \"<string>\"\n },\n \"changes\": {\n \"login\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v0/companies/github/webhook")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"installation\": {\n \"id\": 1,\n \"target_type\": \"<string>\"\n },\n \"account\": {\n \"avatar_url\": \"<string>\",\n \"html_url\": \"<string>\",\n \"login\": \"<string>\"\n },\n \"changes\": {\n \"login\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}Companies
Webhook endpoint called by GitHub on events related to Cantina GitHub App.
The endpoint is publicly accessible so that it is reachable by GitHub.
Payload verification (Webhook HMAC) is done to ensure we are only processing messages from GitHub.
Access control rules
- Publicly accessible.
POST
/
api
/
v0
/
companies
/
github
/
webhook
Webhook endpoint called by GitHub on events related to Cantina GitHub App.
curl --request POST \
--url https://api.example.com/api/v0/companies/github/webhook \
--header 'Content-Type: application/json' \
--data '
{
"installation": {
"id": 1,
"target_type": "<string>"
},
"account": {
"avatar_url": "<string>",
"html_url": "<string>",
"login": "<string>"
},
"changes": {
"login": {}
}
}
'import requests
url = "https://api.example.com/api/v0/companies/github/webhook"
payload = {
"installation": {
"id": 1,
"target_type": "<string>"
},
"account": {
"avatar_url": "<string>",
"html_url": "<string>",
"login": "<string>"
},
"changes": { "login": {} }
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
installation: {id: 1, target_type: '<string>'},
account: {avatar_url: '<string>', html_url: '<string>', login: '<string>'},
changes: {login: {}}
})
};
fetch('https://api.example.com/api/v0/companies/github/webhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v0/companies/github/webhook",
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([
'installation' => [
'id' => 1,
'target_type' => '<string>'
],
'account' => [
'avatar_url' => '<string>',
'html_url' => '<string>',
'login' => '<string>'
],
'changes' => [
'login' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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 := "https://api.example.com/api/v0/companies/github/webhook"
payload := strings.NewReader("{\n \"installation\": {\n \"id\": 1,\n \"target_type\": \"<string>\"\n },\n \"account\": {\n \"avatar_url\": \"<string>\",\n \"html_url\": \"<string>\",\n \"login\": \"<string>\"\n },\n \"changes\": {\n \"login\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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("https://api.example.com/api/v0/companies/github/webhook")
.header("Content-Type", "application/json")
.body("{\n \"installation\": {\n \"id\": 1,\n \"target_type\": \"<string>\"\n },\n \"account\": {\n \"avatar_url\": \"<string>\",\n \"html_url\": \"<string>\",\n \"login\": \"<string>\"\n },\n \"changes\": {\n \"login\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v0/companies/github/webhook")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"installation\": {\n \"id\": 1,\n \"target_type\": \"<string>\"\n },\n \"account\": {\n \"avatar_url\": \"<string>\",\n \"html_url\": \"<string>\",\n \"login\": \"<string>\"\n },\n \"changes\": {\n \"login\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}⌘I