Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qovery Organization Webhook API

The Organization Webhook API from Qovery — 3 operation(s) for organization webhook.

Qovery Organization Webhook API is one of 94 APIs that Qovery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Organization Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, and rate-limit docs.

This API exposes 6 operations across 3 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 1.0.4.

Requests are made against a single base URL, https://api.qovery.com.

6 operations 3 paths 10 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.4
Base URL
https://api.qovery.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Qovery Organization Webhook API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • bearerAuth — 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 ' cu…
  • ApiKeyAuth — Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Curl Example ' curl https://console.qovery.com/organization -…

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Organization Webhook 6
GET
/organization/{organizationId}/webhook
List organization webhooks
listOrganizationWebHooks 1 param → 200401403404
POST
/organization/{organizationId}/webhook
Create an organization webhook
createOrganizationWebhook 1 param body → 201400401403
GET
/organization/{organizationId}/webhook/{webhookId}/event
List events of a webhook
listWebhookEvent 2 params → 200401403404
GET
/organization/{organizationId}/webhook/{webhookId}
Get an Organization webhook
getOrganizationWebhook 2 params → 200401403404
PUT
/organization/{organizationId}/webhook/{webhookId}
Edit an organization webhook
editOrganizationWebhook 2 params body → 200400401403404
DELETE
/organization/{organizationId}/webhook/{webhookId}
Delete organization webhook
deleteOrganizationWebhook 2 params → 204401403404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are WebhookEventResponse (8 properties), OrganizationWebhookCreateRequest (8 properties), Base (3 properties), OrganizationWebhookResponseList (1 property). Each schema is shown below with its type and property counts.

EnvironmentModeEnum
string
OrganizationWebhookCreateResponse
OrganizationWebhookResponseList
object
1 property
OrganizationWebhookCreateRequest
object
8 properties 3 required
OrganizationWebhookKindEnum
string
Define the type of the webhook. SLACK is a special webhook type to push notifications directly to slack. The targeturl must be a Slack compatible endpoint.
OrganizationWebhookEventEnum
string
Events to subscribe to and send to the targeturl. - DEPLOYMENTSTARTED send an event when a deployment is started and going to be executed - DEPLOYMENTCANCELLED…
OrganizationWebhookResponse
WebhookEventResponse
object
8 properties 7 required
WebhookEventResponseList
object
1 property
Base
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-organization-webhook-api-openapi.yml Raw ↑

Other APIs Qovery publishes across the network.

Qovery Account Info API
Qovery Alert Receivers API
Qovery Alert Rules API
Qovery Application Actions API
Qovery Application Configuration API
Qovery Application Custom Domain API
Qovery Application Deployment History API
Qovery Application Deployment Restriction API
Qovery Application Environment Variable API
Qovery Application Logs API
Qovery Application Main Calls API
Qovery Application Secret API