ClickStack: Update Webhook

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

ClickStack: Replaces an existing webhook. Readable optional fields (description, body) are a full replace: omitting them clears them. The write-only fields headers and queryParams are never returned on read, so omitting them preserves the stored values; send an explicit empty object ({}) to clear them. Exception: if the destination (url or service) changes, omitted headers/ queryParams are cleared rather than preserved so stored secrets are never forwarded to a new destination.

PUT

organizations

{organizationId}

services

{serviceId}

clickstack

webhooks

{clickStackWebhookId}

ClickStack: Update Webhook

curl --request PUT \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production Alerts",
  "service": "slack",
  "url": "https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL",
  "description": "Sends critical alerts to the #incidents channel",
  "body": "{\"alert\": \"{{title}}\", \"severity\": \"{{level}}\"}",
  "headers": {},
  "queryParams": {}
}
'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}"

payload = {
    "name": "Production Alerts",
    "service": "slack",
    "url": "https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL",
    "description": "Sends critical alerts to the #incidents channel",
    "body": "{\"alert\": \"{{title}}\", \"severity\": \"{{level}}\"}",
    "headers": {},
    "queryParams": {}
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Production Alerts',
    service: 'slack',
    url: 'https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL',
    description: 'Sends critical alerts to the #incidents channel',
    body: JSON.stringify('{"alert": "{{title}}", "severity": "{{level}}"}'),
    headers: {},
    queryParams: {}
  })
};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}', 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.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Production Alerts',
    'service' => 'slack',
    'url' => 'https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL',
    'description' => 'Sends critical alerts to the #incidents channel',
    'body' => '{"alert": "{{title}}", "severity": "{{level}}"}',
    'headers' => [
        
    ],
    'queryParams' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}"

	payload := strings.NewReader("{\n  \"name\": \"Production Alerts\",\n  \"service\": \"slack\",\n  \"url\": \"https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL\",\n  \"description\": \"Sends critical alerts to the #incidents channel\",\n  \"body\": \"{\\\"alert\\\": \\\"{{title}}\\\", \\\"severity\\\": \\\"{{level}}\\\"}\",\n  \"headers\": {},\n  \"queryParams\": {}\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.put("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Production Alerts\",\n  \"service\": \"slack\",\n  \"url\": \"https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL\",\n  \"description\": \"Sends critical alerts to the #incidents channel\",\n  \"body\": \"{\\\"alert\\\": \\\"{{title}}\\\", \\\"severity\\\": \\\"{{level}}\\\"}\",\n  \"headers\": {},\n  \"queryParams\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Production Alerts\",\n  \"service\": \"slack\",\n  \"url\": \"https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL\",\n  \"description\": \"Sends critical alerts to the #incidents channel\",\n  \"body\": \"{\\\"alert\\\": \\\"{{title}}\\\", \\\"severity\\\": \\\"{{level}}\\\"}\",\n  \"headers\": {},\n  \"queryParams\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "id": "507f1f77bcf86cd799439011",
    "name": "Production Alerts",
    "service": "slack",
    "updatedAt": "2025-06-15T10:30:00.000Z",
    "createdAt": "2025-01-01T00:00:00.000Z",
    "url": "https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL",
    "description": "Sends critical alerts to the #incidents channel"
  }
}

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Beta This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

ClickStack: Replaces an existing webhook. Readable optional fields (description, body) are a full replace: omitting them clears them. The write-only fields headers and queryParams are never returned on read, so omitting them preserves the stored values; send an explicit empty object ({}) to clear them. Exception: if the destination (url or service) changes, omitted headers/ queryParams are cleared rather than preserved so stored secrets are never forwarded to a new destination.

Authorizations

Authorization

string

header

required

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path Parameters

organizationId

string<uuid>

required

ID of the organization that owns the service.

serviceId

string<uuid>

required

ID of the ClickStack service.

clickStackWebhookId

string

required

Webhook ID

Body

application/json

name

string

required

Webhook name. Must be unique per service within the team.

Example:

"Production Alerts"

service

enum<string>

required

Webhook service type.

Available options:

slack,

incidentio,

generic

Example:

"slack"

url

string

required

Webhook destination URL.

Example:

"https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL"

description

string

Webhook description, shown in the UI.

Example:

"Sends critical alerts to the #incidents channel"

body

string

Optional request body template. Only for generic/incidentio; rejected for slack.

Example:

"{\"alert\": \"{{title}}\", \"severity\": \"{{level}}\"}"

headers

object

Show child attributes

queryParams

object

Show child attributes

Response

Successful response

status

number

HTTP status code.

Example:

200

requestId

string<uuid>

Unique id assigned to every request. UUIDv4

result

object

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

Last modified on July 22, 2026

ClickStack: Delete Webhook**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. <br /><br /> ClickStack: Deletes a webhook. Blocked with a 409 while any alert still references it — reassign or remove those alerts first — so deletion never leaves an alert pointing at a missing webhook (which would silently drop notifications). Mirrors the internal webhook delete guard.

ClickStack: Update Webhook

curl --request PUT \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production Alerts",
  "service": "slack",
  "url": "https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL",
  "description": "Sends critical alerts to the #incidents channel",
  "body": "{\"alert\": \"{{title}}\", \"severity\": \"{{level}}\"}",
  "headers": {},
  "queryParams": {}
}
'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}"

payload = {
    "name": "Production Alerts",
    "service": "slack",
    "url": "https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL",
    "description": "Sends critical alerts to the #incidents channel",
    "body": "{\"alert\": \"{{title}}\", \"severity\": \"{{level}}\"}",
    "headers": {},
    "queryParams": {}
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Production Alerts',
    service: 'slack',
    url: 'https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL',
    description: 'Sends critical alerts to the #incidents channel',
    body: JSON.stringify('{"alert": "{{title}}", "severity": "{{level}}"}'),
    headers: {},
    queryParams: {}
  })
};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}', 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.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Production Alerts',
    'service' => 'slack',
    'url' => 'https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL',
    'description' => 'Sends critical alerts to the #incidents channel',
    'body' => '{"alert": "{{title}}", "severity": "{{level}}"}',
    'headers' => [
        
    ],
    'queryParams' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}"

	payload := strings.NewReader("{\n  \"name\": \"Production Alerts\",\n  \"service\": \"slack\",\n  \"url\": \"https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL\",\n  \"description\": \"Sends critical alerts to the #incidents channel\",\n  \"body\": \"{\\\"alert\\\": \\\"{{title}}\\\", \\\"severity\\\": \\\"{{level}}\\\"}\",\n  \"headers\": {},\n  \"queryParams\": {}\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.put("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Production Alerts\",\n  \"service\": \"slack\",\n  \"url\": \"https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL\",\n  \"description\": \"Sends critical alerts to the #incidents channel\",\n  \"body\": \"{\\\"alert\\\": \\\"{{title}}\\\", \\\"severity\\\": \\\"{{level}}\\\"}\",\n  \"headers\": {},\n  \"queryParams\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Production Alerts\",\n  \"service\": \"slack\",\n  \"url\": \"https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL\",\n  \"description\": \"Sends critical alerts to the #incidents channel\",\n  \"body\": \"{\\\"alert\\\": \\\"{{title}}\\\", \\\"severity\\\": \\\"{{level}}\\\"}\",\n  \"headers\": {},\n  \"queryParams\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "id": "507f1f77bcf86cd799439011",
    "name": "Production Alerts",
    "service": "slack",
    "updatedAt": "2025-06-15T10:30:00.000Z",
    "createdAt": "2025-01-01T00:00:00.000Z",
    "url": "https://hooks.slack.com/services/EXAMPLE/WEBHOOK/URL",
    "description": "Sends critical alerts to the #incidents channel"
  }
}

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}