Get git webhook status for a service
curl --request GET \
--url https://api.qovery.com/service/{serviceId}/gitWebhookStatus \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.qovery.com/service/{serviceId}/gitWebhookStatus"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.qovery.com/service/{serviceId}/gitWebhookStatus', 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.qovery.com/service/{serviceId}/gitWebhookStatus",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.qovery.com/service/{serviceId}/gitWebhookStatus"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.qovery.com/service/{serviceId}/gitWebhookStatus")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/service/{serviceId}/gitWebhookStatus")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "ACTIVE",
"provider": "GITHUB",
"missing_events": [
"<string>"
]
}Service Main Calls
Get git webhook status for a service
Returns the webhook status for a git-based service. Checks if the Qovery webhook is correctly configured on the git provider (GitHub, GitLab, or Bitbucket).
GET
/
service
/
{serviceId}
/
gitWebhookStatus
Get git webhook status for a service
curl --request GET \
--url https://api.qovery.com/service/{serviceId}/gitWebhookStatus \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.qovery.com/service/{serviceId}/gitWebhookStatus"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.qovery.com/service/{serviceId}/gitWebhookStatus', 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.qovery.com/service/{serviceId}/gitWebhookStatus",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.qovery.com/service/{serviceId}/gitWebhookStatus"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.qovery.com/service/{serviceId}/gitWebhookStatus")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/service/{serviceId}/gitWebhookStatus")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "ACTIVE",
"provider": "GITHUB",
"missing_events": [
"<string>"
]
}Authorizations
bearerAuthApiKeyAuth
JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '
Path Parameters
Service ID of an application/job/container/database
Response
Webhook status
The webhook configuration status:
- ACTIVE: Webhook is properly configured with all required events
- NOT_CONFIGURED: No Qovery webhook found on the git rep
- MISCONFIGURED: Webhook exists but is missing required events
- UNABLE_TO_VERIFY: Could not check webhook status (auth error, rate limit, etc.)
Available options:
ACTIVE, NOT_CONFIGURED, MISCONFIGURED, UNABLE_TO_VERIFY The git provider where the webhook is configured
Available options:
GITHUB, GITLAB, BITBUCKET List of required events that are missing from the webhook configuration (only present when status is MISCONFIGURED)
Was this page helpful?