Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

ClickStack: Validate Webhook

POST/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/validate
API playground

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

ClickStack: Validates a webhook body against the same schema, URL rules, and body template check used by POST /api/v2/webhooks. The webhook is never persisted. Use this endpoint at plan time (e.g. from a Terraform provider) to check that a webhook configuration is valid before applying it. Name uniqueness is not checked.

Permission

The API key must have the control-plane:service:manage-clickstack-api permission.

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the organization that owns the service.

    format: uuid
  • serviceIdstringrequired

    ID of the ClickStack service.

    format: uuid

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 Handlebars request body template. Only for generic/incidentio; rejected for slack. Rejected with a 400 if it does not compile or calls a helper other than eq and the Handlebars built-ins.

    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
  • resultoptionalobject
    3 properties
    • validbooleanrequired

      True when the body passes all validation rules.

    • errorsarray ofobjectrequired

      Validation errors. Empty when valid is true.

      2 properties
      • pathstringrequired

        Dot-separated field path, or empty string for top-level errors.

      • messagestringrequired

        Human-readable error description.

    • normalizedClickStackValidateWebhookResponseNormalizedornullrequired
      2 variants

      One of the following:

      • ClickStackValidateWebhookResponseNormalized
      • null