Skip to main content
GET
/
organization
/
{organizationId}
/
webhook
/
{webhookId}
Get an Organization webhook
curl --request GET \
  --url https://api.qovery.com/organization/{organizationId}/webhook/{webhookId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.qovery.com/organization/{organizationId}/webhook/{webhookId}"

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/organization/{organizationId}/webhook/{webhookId}', 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/organization/{organizationId}/webhook/{webhookId}",
  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/organization/{organizationId}/webhook/{webhookId}"

	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/organization/{organizationId}/webhook/{webhookId}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/organization/{organizationId}/webhook/{webhookId}")

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
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "kind": "STANDARD",
  "target_url": "<string>",
  "target_secret_set": true,
  "description": "<string>",
  "enabled": true,
  "events": [],
  "project_names_filter": [
    "<string>"
  ],
  "environment_types_filter": [
    "PRODUCTION"
  ]
}

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

organizationId
string<uuid>
required

Organization ID

webhookId
string<uuid>
required

Webhook ID

Response

Get organization webhook

id
string<uuid>
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
read-only
kind
enum<string>

Define the type of the webhook. SLACK is a special webhook type to push notifications directly to slack. The target_url must be a Slack compatible endpoint.

Available options:
STANDARD,
SLACK
Example:

"STANDARD"

target_url
string

Set the public HTTP or HTTPS endpoint that will receive the specified events. The target URL must starts with http:// or https://

target_secret_set
boolean
description
string
enabled
boolean

Turn on or off your endpoint.

events
enum<string>[]

Events to subscribe to and send to the target_url.

  • DEPLOYMENT_STARTED send an event when a deployment is started and going to be executed
  • DEPLOYMENT_CANCELLED send an event when a deployment is cancelled
  • DEPLOYMENT_FAILURE send an event when a deployment failed
  • DEPLOYMENT_SUCCESSFUL send an event when a deployment is successful
Available options:
DEPLOYMENT_STARTED,
DEPLOYMENT_CANCELLED,
DEPLOYMENT_FAILURE,
DEPLOYMENT_SUCCESSFUL
project_names_filter
string[]

Specify the project names you want to filter to. This webhook will be triggered only if the event is coming from the specified Project IDs. Notes: 1. Wildcard is accepted E.g. product*. 2. Name is case insensitive.

environment_types_filter
enum<string>[]

Specify the environment modes you want to filter to. This webhook will be triggered only if the event is coming from an environment with the specified mode.

Available options:
DEVELOPMENT,
PREVIEW,
PRODUCTION,
STAGING