Skip to main content
POST
/
webhook
/
analysis
/
{platformType}
/
{platformSubType}
/
{analysisId}
Add webhook to an analysis
curl --request POST \
  --url https://{host}/webhook/analysis/{platformType}/{platformSubType}/{analysisId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "uri": "https://mycallbackServer:443/api/test/webhook",
  "authType": "basic",
  "authValue": "saasUser:password1"
}
'
import requests

url = "https://{host}/webhook/analysis/{platformType}/{platformSubType}/{analysisId}"

payload = {
"uri": "https://mycallbackServer:443/api/test/webhook",
"authType": "basic",
"authValue": "saasUser:password1"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
uri: 'https://mycallbackServer:443/api/test/webhook',
authType: 'basic',
authValue: 'saasUser:password1'
})
};

fetch('https://{host}/webhook/analysis/{platformType}/{platformSubType}/{analysisId}', 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://{host}/webhook/analysis/{platformType}/{platformSubType}/{analysisId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'uri' => 'https://mycallbackServer:443/api/test/webhook',
'authType' => 'basic',
'authValue' => 'saasUser:password1'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://{host}/webhook/analysis/{platformType}/{platformSubType}/{analysisId}"

payload := strings.NewReader("{\n \"uri\": \"https://mycallbackServer:443/api/test/webhook\",\n \"authType\": \"basic\",\n \"authValue\": \"saasUser:password1\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://{host}/webhook/analysis/{platformType}/{platformSubType}/{analysisId}")
.header("Content-Type", "application/json")
.body("{\n \"uri\": \"https://mycallbackServer:443/api/test/webhook\",\n \"authType\": \"basic\",\n \"authValue\": \"saasUser:password1\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{host}/webhook/analysis/{platformType}/{platformSubType}/{analysisId}")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"uri\": \"https://mycallbackServer:443/api/test/webhook\",\n \"authType\": \"basic\",\n \"authValue\": \"saasUser:password1\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "ok",
  "status": 200
}

Path Parameters

platformType
enum<string>
required
Available options:
cloud,
containers
platformSubType
enum<string>
required
Available options:
aws,
gcp,
azure,
kubernetes
analysisId
string
required

Body

application/json
uri
string<uri>
required

Fully-qualified webhook URI reachable by Kubex.

authType
string

e.g., "Basic", "Bearer".

authValue
string

Credential (user:pass or token).

Response

OK

message
string
required
status
integer
required