Skip to main content
POST
/
service
/
{serviceId}
/
gitWebhook
/
sync
Synchronize git webhook for a service
curl --request POST \
  --url https://api.qovery.com/service/{serviceId}/gitWebhook/sync \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.qovery.com/service/{serviceId}/gitWebhook/sync"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.qovery.com/service/{serviceId}/gitWebhook/sync', 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}/gitWebhook/sync",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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}/gitWebhook/sync"

	req, _ := http.NewRequest("POST", 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.post("https://api.qovery.com/service/{serviceId}/gitWebhook/sync")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/service/{serviceId}/gitWebhook/sync")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "missing_events": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

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

serviceId
string<uuid>
required

Service ID of an application/job/container/database

Response

Webhook synchronized successfully

status
enum<string>
required

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
provider
enum<string>
required

The git provider where the webhook is configured

Available options:
GITHUB,
GITLAB,
BITBUCKET
missing_events
string[]

List of required events that are missing from the webhook configuration (only present when status is MISCONFIGURED)