Skip to main content
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>'
{
  "status": "ACTIVE",
  "provider": "GITHUB",
  "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 status

​
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)