Synchronize git webhook for a service

Synchronizes the Qovery webhook configuration for a git-based service.

• If no webhook exists, creates one with the correct configuration
• If webhook exists but is misconfigured, updates it with the correct events
• If webhook is already correctly configured, returns current status Works with GitHub, GitLab, and Bitbucket repositories.

POST /service/{serviceId}/gitWebhook/sync

Synchronize git webhook for a service

cURL

curl --request POST \
  --url https://api.qovery.com/service/{serviceId}/gitWebhook/sync \
  --header 'Authorization: Bearer <token>'

200

{
  "status": "ACTIVE",
  "provider": "GITHUB",
  "missing_events": [
    "<string>"
  ]
}

Authorizations

bearerAuthApiKeyAuth

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

200

application/json

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)