ClickStack: Update Alert | ClickHouse Docs

PUT/v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId}

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

ClickStack: Updates an existing alert

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
clickStackAlertIdstringrequired
ClickStack Alert ID

Request bodyJSON

dashboardIdoptionalstring | null
Dashboard ID for tile-based alerts.

Example: "65f5e4a3b9e77c001a567890"
tileIdoptionalstring | null
Tile ID for tile-based alerts. Must be a line, stacked bar, or number type tile.

Example: "65f5e4a3b9e77c001a901234"
savedSearchIdoptionalstring | null
Saved search ID for saved_search alerts.

Example: "65f5e4a3b9e77c001a345678"
groupByoptionalstring | null
Group-by key for saved search alerts.

Example: "ServiceName"
thresholdoptionalnumber
Threshold value for triggering the alert. For between and not_between threshold types, this is the lower bound.

Example: 100
thresholdMaxoptionalnumber | null
Upper bound for between and not_between threshold types. Required when thresholdType is between or not_between, must be >= threshold.

Example: 500
intervaloptional30sor1mor5mor15mor30mor1h+3 more
Evaluation interval for the alert. 30s requires the 30s alert interval feature to be enabled for your team.

Example: "1h"
scheduleOffsetMinutesoptionalinteger | null
Offset from the interval boundary in minutes. For example, 2 with a 5m interval evaluates windows at :02, :07, :12, etc. (UTC).

Example: 2
scheduleStartAtoptionalstring | null
Absolute UTC start time anchor. Alert windows start from this timestamp and repeat every interval.

format: date-time
Example: "2026-02-08T10:00:00.000Z"
sourceoptionalsaved_searchortile
Alert source type (tile-based or saved search).

Example: "tile"
thresholdTypeoptionalaboveorbeloworabove_exclusiveorbelow_or_equalorequalornot_equal+2 more
Threshold comparison direction.

Example: "above"
channeloptionalClickStackAlertChannelEmailorClickStackAlertChannelWebhook
2 variants
One of the following:
ClickStackAlertChannelEmail
View ClickStackAlertChannelEmail schema →
2 properties
typewebhookoremailrequired
Channel type. Must be "email" for email alerts.

emailRecipientsarray ofstringrequired
Email recipients for email alerts.

ClickStackAlertChannelWebhook
View ClickStackAlertChannelWebhook schema →
5 properties
typewebhookoremailrequired
Channel type. Must be "webhook" for webhook alerts.

webhookIdstringrequired
Webhook destination ID.

Example: "65f5e4a3b9e77c001a789012"
webhookServiceoptionalstring | null
Webhook service type (e.g., slack_api).

Example: "slack_api"
slackChannelIdoptionalstring | null
Slack channel ID for Slack webhooks.

Example: "C01ABCDEF23"
severityoptionalcriticalorerrororwarningorinfo
Severity label used by PagerDuty API webhooks.
channelsoptionalarray ofClickStackAlertChannelEmailorClickStackAlertChannelWebhook
Notification channels to trigger when the alert fires or resolves. Between 1 and 10 channels; duplicates are rejected.
2 variants
One of the following:
ClickStackAlertChannelEmail
View ClickStackAlertChannelEmail schema →
2 properties
typewebhookoremailrequired
Channel type. Must be "email" for email alerts.

emailRecipientsarray ofstringrequired
Email recipients for email alerts.

ClickStackAlertChannelWebhook
View ClickStackAlertChannelWebhook schema →
5 properties
typewebhookoremailrequired
Channel type. Must be "webhook" for webhook alerts.

webhookIdstringrequired
Webhook destination ID.

Example: "65f5e4a3b9e77c001a789012"
webhookServiceoptionalstring | null
Webhook service type (e.g., slack_api).

Example: "slack_api"
slackChannelIdoptionalstring | null
Slack channel ID for Slack webhooks.

Example: "C01ABCDEF23"
severityoptionalcriticalorerrororwarningorinfo
Severity label used by PagerDuty API webhooks.
nameoptionalstring | null
Human-friendly alert name.

Example: "Test Alert"
messageoptionalstring | null
Alert message template.

Example: "Test Alert Message"
noteoptionalstring | null
Freeform note for the alert. Supports markdown formatting.

Example: "Threshold raised from 50 to 100 on 2026-01-15. See [runbook](https://wiki.example.com/runbook)."
numConsecutiveWindowsoptionalinteger | null
Fire the alert only after its condition has been met for this many consecutive evaluation windows. While the condition is met but fewer than this many consecutive windows have violated, the alert is in the PENDING state.

Example: 3

Response

JSON

200

Successful response

JSON

statusoptionalnumber
HTTP status code.

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

format: uuid
resultoptionalobject
24 properties
- dashboardIdoptionalstring | null
  Dashboard ID for tile-based alerts.
  
  Example: "65f5e4a3b9e77c001a567890"
- tileIdoptionalstring | null
  Tile ID for tile-based alerts. Must be a line, stacked bar, or number type tile.
  
  Example: "65f5e4a3b9e77c001a901234"
- savedSearchIdoptionalstring | null
  Saved search ID for saved_search alerts.
  
  Example: "65f5e4a3b9e77c001a345678"
- groupByoptionalstring | null
  Group-by key for saved search alerts.
  
  Example: "ServiceName"
- thresholdoptionalnumber
  Threshold value for triggering the alert. For between and not_between threshold types, this is the lower bound.
  
  Example: 100
- thresholdMaxoptionalnumber | null
  Upper bound for between and not_between threshold types. Required when thresholdType is between or not_between, must be >= threshold.
  
  Example: 500
- intervaloptional30sor1mor5mor15mor30mor1h+3 more
  Evaluation interval for the alert. 30s requires the 30s alert interval feature to be enabled for your team.
  
  Example: "1h"
- scheduleOffsetMinutesoptionalinteger | null
  Offset from the interval boundary in minutes. For example, 2 with a 5m interval evaluates windows at :02, :07, :12, etc. (UTC).
  
  Example: 2
- scheduleStartAtoptionalstring | null
  Absolute UTC start time anchor. Alert windows start from this timestamp and repeat every interval.
  
  format: date-time
  Example: "2026-02-08T10:00:00.000Z"
- sourceoptionalsaved_searchortile
  Alert source type (tile-based or saved search).
  
  Example: "tile"
- thresholdTypeoptionalaboveorbeloworabove_exclusiveorbelow_or_equalorequalornot_equal+2 more
  Threshold comparison direction.
  
  Example: "above"
- channeloptionalClickStackAlertChannelEmailorClickStackAlertChannelWebhook
  2 variants
  One of the following:
  ClickStackAlertChannelEmail
  View ClickStackAlertChannelEmail schema →
  2 properties
  typewebhookoremailrequired
  Channel type. Must be "email" for email alerts.
  
  emailRecipientsarray ofstringrequired
  Email recipients for email alerts.
  
  ClickStackAlertChannelWebhook
  View ClickStackAlertChannelWebhook schema →
  5 properties
  typewebhookoremailrequired
  Channel type. Must be "webhook" for webhook alerts.
  
  webhookIdstringrequired
  Webhook destination ID.
  
  Example: "65f5e4a3b9e77c001a789012"
  webhookServiceoptionalstring | null
  Webhook service type (e.g., slack_api).
  
  Example: "slack_api"
  slackChannelIdoptionalstring | null
  Slack channel ID for Slack webhooks.
  
  Example: "C01ABCDEF23"
  severityoptionalcriticalorerrororwarningorinfo
  Severity label used by PagerDuty API webhooks.
- channelsoptionalarray ofClickStackAlertChannelEmailorClickStackAlertChannelWebhook
  Notification channels to trigger when the alert fires or resolves. Between 1 and 10 channels; duplicates are rejected.
  
  2 variants
  One of the following:
  ClickStackAlertChannelEmail
  View ClickStackAlertChannelEmail schema →
  2 properties
  typewebhookoremailrequired
  Channel type. Must be "email" for email alerts.
  
  emailRecipientsarray ofstringrequired
  Email recipients for email alerts.
  
  ClickStackAlertChannelWebhook
  View ClickStackAlertChannelWebhook schema →
  5 properties
  typewebhookoremailrequired
  Channel type. Must be "webhook" for webhook alerts.
  
  webhookIdstringrequired
  Webhook destination ID.
  
  Example: "65f5e4a3b9e77c001a789012"
  webhookServiceoptionalstring | null
  Webhook service type (e.g., slack_api).
  
  Example: "slack_api"
  slackChannelIdoptionalstring | null
  Slack channel ID for Slack webhooks.
  
  Example: "C01ABCDEF23"
  severityoptionalcriticalorerrororwarningorinfo
  Severity label used by PagerDuty API webhooks.
- nameoptionalstring | null
  Human-friendly alert name.
  
  Example: "Test Alert"
- messageoptionalstring | null
  Alert message template.
  
  Example: "Test Alert Message"
- noteoptionalstring | null
  Freeform note for the alert. Supports markdown formatting.
  
  Example: "Threshold raised from 50 to 100 on 2026-01-15. See [runbook](https://wiki.example.com/runbook)."
- numConsecutiveWindowsoptionalinteger | null
  Fire the alert only after its condition has been met for this many consecutive evaluation windows. While the condition is met but fewer than this many consecutive windows have violated, the alert is in the PENDING state.
  
  Example: 3
- idoptionalstring
  Unique alert identifier.
  
  Example: "65f5e4a3b9e77c001a123456"
- stateoptionalALERTorOKorINSUFFICIENT_DATAorDISABLEDorPENDING
  Current alert state.
  
  Example: "ALERT"
- teamIdoptionalstring
  Team identifier.
  
  Example: "65f5e4a3b9e77c001a345678"
- silencedoptionalClickStackAlertSilencedornull
  2 variants
  One of the following:
  ClickStackAlertSilenced
  View ClickStackAlertSilenced schema →
  3 properties
  byoptionalstring | null
  User ID who silenced the alert.
  
  Example: "65f5e4a3b9e77c001a234567"
  atoptionalstring
  Silence start timestamp.
  
  format: date-time
  Example: "2026-03-19T08:00:00.000Z"
  untiloptionalstring
  Silence end timestamp.
  
  format: date-time
  Example: "2026-03-20T08:00:00.000Z"
  null
- executionErrorsoptionalarray ofobject
  Errors recorded during the most recent alert execution, if any.
  
  3 properties
  timestampstringrequired
  When the error occurred.
  
  format: date-time
  Example: "2026-04-17T12:00:00.000Z"
  typeQUERY_ERRORorQUERY_TIMEOUTorWEBHOOK_ERRORorINVALID_ALERTorUNKNOWNrequired
  Category of the error.
  
  Example: "QUERY_ERROR"
  messagestringrequired
  Human-readable error message.
  
  Example: "Query timed out after 30s"
- createdAtoptionalstring | null
  Creation timestamp.
  
  format: date-time
  Example: "2023-01-01T00:00:00.000Z"
- updatedAtoptionalstring | null
  Last update timestamp.
  
  format: date-time
  Example: "2023-01-01T00:00:00.000Z"

ClickStack: Update Alert

curl --request PUT \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickstack/alerts/string \
  --header 'Authorization: Basic <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dashboardId": "65f5e4a3b9e77c001a567890",
  "tileId": "65f5e4a3b9e77c001a901234",
  "savedSearchId": "65f5e4a3b9e77c001a345678",
  "groupBy": "ServiceName",
  "threshold": 100,
  "thresholdMax": 500,
  "interval": "1h",
  "scheduleOffsetMinutes": 2,
  "scheduleStartAt": "2026-02-08T10:00:00.000Z",
  "source": "tile",
  "thresholdType": "above",
  "channel": {
    "type": "webhook",
    "emailRecipients": [
      "string"
    ]
  },
  "channels": [
    {
      "type": "webhook",
      "emailRecipients": [
        "string"
      ]
    }
  ],
  "name": "Test Alert",
  "message": "Test Alert Message",
  "note": "Threshold raised from 50 to 100 on 2026-01-15. See [runbook](https://wiki.example.com/runbook).",
  "numConsecutiveWindows": 3
}
'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/clickstack/alerts/string';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', Authorization: 'Basic <token>'},
  body: JSON.stringify({
    dashboardId: '65f5e4a3b9e77c001a567890',
    tileId: '65f5e4a3b9e77c001a901234',
    savedSearchId: '65f5e4a3b9e77c001a345678',
    groupBy: 'ServiceName',
    threshold: 100,
    thresholdMax: 500,
    interval: '1h',
    scheduleOffsetMinutes: 2,
    scheduleStartAt: '2026-02-08T10:00:00.000Z',
    source: 'tile',
    thresholdType: 'above',
    channel: {type: 'webhook', emailRecipients: ['string']},
    channels: [{type: 'webhook', emailRecipients: ['string']}],
    name: 'Test Alert',
    message: 'Test Alert Message',
    note: 'Threshold raised from 50 to 100 on 2026-01-15. See [runbook](https://wiki.example.com/runbook).',
    numConsecutiveWindows: 3
  })
};

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/alerts/string"

payload = {
    "dashboardId": "65f5e4a3b9e77c001a567890",
    "tileId": "65f5e4a3b9e77c001a901234",
    "savedSearchId": "65f5e4a3b9e77c001a345678",
    "groupBy": "ServiceName",
    "threshold": 100,
    "thresholdMax": 500,
    "interval": "1h",
    "scheduleOffsetMinutes": 2,
    "scheduleStartAt": "2026-02-08T10:00:00.000Z",
    "source": "tile",
    "thresholdType": "above",
    "channel": {
        "type": "webhook",
        "emailRecipients": ["string"]
    },
    "channels": [
        {
            "type": "webhook",
            "emailRecipients": ["string"]
        }
    ],
    "name": "Test Alert",
    "message": "Test Alert Message",
    "note": "Threshold raised from 50 to 100 on 2026-01-15. See [runbook](https://wiki.example.com/runbook).",
    "numConsecutiveWindows": 3
}
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": {
    "dashboardId": "65f5e4a3b9e77c001a567890",
    "tileId": "65f5e4a3b9e77c001a901234",
    "savedSearchId": "65f5e4a3b9e77c001a345678",
    "groupBy": "ServiceName",
    "threshold": 100,
    "thresholdMax": 500,
    "interval": "1h",
    "scheduleOffsetMinutes": 2,
    "scheduleStartAt": "2026-02-08T10:00:00.000Z",
    "source": "tile",
    "thresholdType": "above",
    "channel": {
      "type": "webhook",
      "emailRecipients": [
        "string"
      ]
    },
    "channels": [
      {
        "type": "webhook",
        "emailRecipients": [
          "string"
        ]
      }
    ],
    "name": "Test Alert",
    "message": "Test Alert Message",
    "note": "Threshold raised from 50 to 100 on 2026-01-15. See [runbook](https://wiki.example.com/runbook).",
    "numConsecutiveWindows": 3,
    "id": "65f5e4a3b9e77c001a123456",
    "state": "ALERT",
    "teamId": "65f5e4a3b9e77c001a345678",
    "silenced": {
      "by": "65f5e4a3b9e77c001a234567",
      "at": "2026-03-19T08:00:00.000Z",
      "until": "2026-03-20T08:00:00.000Z"
    },
    "executionErrors": [
      {
        "timestamp": "2026-04-17T12:00:00.000Z",
        "type": "QUERY_ERROR",
        "message": "Query timed out after 30s"
      }
    ],
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-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"
}