ClickStack: Update Webhook | ClickHouse Docs

PUT/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}

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

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

Path parameters

organizationIdstringrequired
ID of the organization that owns the service.

format: uuid
serviceIdstringrequired
ID of the ClickStack service.

format: uuid
clickStackWebhookIdstringrequired
Webhook ID

Request bodyJSON

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

Example: "Production Alerts"
serviceslackorincidentioorgenericrequired
Webhook service type.

Example: "slack"
urlstringrequired
Webhook destination URL.

Example: "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
descriptionoptionalstring
Webhook description, shown in the UI.

Example: "Sends critical alerts to the #incidents channel"
bodyoptionalstring
Optional request body template. Only for generic/incidentio; rejected for slack.

Example: "{\"alert\": \"{{title}}\", \"severity\": \"{{level}}\"}"
headersoptionalmap ofstring
queryParamsoptionalmap ofstring

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

Example: 200
requestIdoptionalstring
Unique id assigned to every request. UUIDv4

format: uuid
resultoptionalClickStackSlackWebhookorClickStackIncidentIOWebhookorClickStackGenericWebhookorClickStackSlackAPIWebhookorClickStackPagerDutyAPIWebhook
5 variants
One of the following:
ClickStackSlackWebhook
View ClickStackSlackWebhook schema →
7 properties
idstringrequired
Webhook ID

Example: "507f1f77bcf86cd799439011"
namestringrequired
Webhook name

Example: "Production Alerts"
serviceslackrequired
Webhook service type

Example: "slack"
updatedAtstringrequired
Last update timestamp

format: date-time
Example: "2025-06-15T10:30:00.000Z"
createdAtstringrequired
Creation timestamp

format: date-time
Example: "2025-01-01T00:00:00.000Z"
urloptionalstring
Slack incoming webhook URL

Example: "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
descriptionoptionalstring
Webhook description, shown in the UI

Example: "Sends critical alerts to the #incidents channel"
ClickStackIncidentIOWebhook
View ClickStackIncidentIOWebhook schema →
7 properties
idstringrequired
Webhook ID

Example: "507f1f77bcf86cd799439012"
namestringrequired
Webhook name

Example: "Incident Response"
serviceincidentiorequired
Webhook service type

Example: "incidentio"
updatedAtstringrequired
Last update timestamp

format: date-time
Example: "2025-06-15T10:30:00.000Z"
createdAtstringrequired
Creation timestamp

format: date-time
Example: "2025-01-01T00:00:00.000Z"
urloptionalstring
incident.io alert event HTTP source URL

Example: "https://api.incident.io/v2/alert_events/http/abc123"
descriptionoptionalstring
Webhook description, shown in the UI

Example: "Routes alerts to incident.io for on-call escalation"
ClickStackGenericWebhook
View ClickStackGenericWebhook schema →
8 properties
idstringrequired
Webhook ID

Example: "507f1f77bcf86cd799439013"
namestringrequired
Webhook name

Example: "PagerDuty Integration"
servicegenericrequired
Webhook service type

Example: "generic"
updatedAtstringrequired
Last update timestamp

format: date-time
Example: "2025-06-15T10:30:00.000Z"
createdAtstringrequired
Creation timestamp

format: date-time
Example: "2025-01-01T00:00:00.000Z"
urloptionalstring
Webhook destination URL

Example: "https://example.com/webhooks/alerts"
descriptionoptionalstring
Webhook description, shown in the UI

Example: "Forwards alert payloads to an external monitoring service"
bodyoptionalstring
Optional request body template

Example: "{\"alert\": \"{{title}}\", \"severity\": \"{{level}}\"}"
ClickStackSlackAPIWebhook
View ClickStackSlackAPIWebhook schema →
7 properties
idstringrequired
Webhook ID

Example: "65f5e4a3b9e77c001a789012"
namestringrequired
Webhook name

Example: "Slack Alerts"
serviceslack_apirequired
Webhook service type

Example: "slack_api"
updatedAtstringrequired
Last update timestamp

format: date-time
Example: "2025-01-15T12:00:00.000Z"
createdAtstringrequired
Creation timestamp

format: date-time
Example: "2025-01-01T00:00:00.000Z"
urloptionalstring
Slack API endpoint URL

Example: "https://hooks.slack.com/services/T00/B00/xxxx"
descriptionoptionalstring
Webhook description, shown in the UI

Example: "Sends alerts to #engineering channel"
ClickStackPagerDutyAPIWebhook
View ClickStackPagerDutyAPIWebhook schema →
7 properties
idstringrequired
Webhook ID

Example: "65f5e4a3b9e77c001a789013"
namestringrequired
Webhook name

Example: "PagerDuty Alerts"
servicepagerduty_apirequired
Webhook service type

Example: "pagerduty_api"
updatedAtstringrequired
Last update timestamp

format: date-time
Example: "2025-01-15T12:00:00.000Z"
createdAtstringrequired
Creation timestamp

format: date-time
Example: "2025-01-01T00:00:00.000Z"
urloptionalstring
PagerDuty Events API endpoint URL

Example: "https://events.pagerduty.com/v2/enqueue"
descriptionoptionalstring
Webhook description, shown in the UI

Example: "Sends critical alerts to PagerDuty"

ClickStack: Update Webhook

curl --request PUT \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickstack/webhooks/string \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production Alerts",
  "service": "slack",
  "url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
  "description": "Sends critical alerts to the #incidents channel",
  "body": "{\"alert\": \"{{title}}\", \"severity\": \"{{level}}\"}",
  "headers": {
    "property1": "string",
    "property2": "string"
  },
  "queryParams": {
    "property1": "string",
    "property2": "string"
  }
}
'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickstack/webhooks/string';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', Authorization: 'Basic <token>'},
  body: JSON.stringify({
    name: 'Production Alerts',
    service: 'slack',
    url: 'https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX',
    description: 'Sends critical alerts to the #incidents channel',
    body: JSON.stringify('{"alert": "{{title}}", "severity": "{{level}}"}'),
    headers: {property1: 'string', property2: 'string'},
    queryParams: {property1: 'string', property2: 'string'}
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickstack/webhooks/string"

payload = {
    "name": "Production Alerts",
    "service": "slack",
    "url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
    "description": "Sends critical alerts to the #incidents channel",
    "body": "{\"alert\": \"{{title}}\", \"severity\": \"{{level}}\"}",
    "headers": {
        "property1": "string",
        "property2": "string"
    },
    "queryParams": {
        "property1": "string",
        "property2": "string"
    }
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Basic <token>"
}

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

print(response.text)

Response example

{
  "status": 200,
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "result": {
    "id": "507f1f77bcf86cd799439011",
    "name": "Production Alerts",
    "service": "slack",
    "url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
    "description": "Sends critical alerts to the #incidents channel",
    "updatedAt": "2025-06-15T10:30:00.000Z",
    "createdAt": "2025-01-01T00:00:00.000Z"
  }
}

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}