Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

ClickStack: List Webhooks

Beta
View as MarkdownEdit this pageReport an issueSet up docs MCP
GET/v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks

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

ClickStack: Retrieves webhooks for the authenticated team (paginated). Results are capped at limit (default and maximum 1000). When totalCount exceeds the number of returned items, page with limit/offset to retrieve them all.

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the organization that owns the service.

    format: uuid
  • serviceIdstringrequired

    ID of the ClickStack service.

    format: uuid

Query parameters

  • limitoptionalinteger

    Maximum number of results to return.

    maximum: 1000, minimum: 1
    Default: 1000
  • offsetoptionalinteger

    Number of results to skip before returning.

    minimum: 0
    Default: 0

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalarray ofClickStackSlackWebhookorClickStackIncidentIOWebhookorClickStackGenericWebhookorClickStackSlackAPIWebhookorClickStackPagerDutyAPIWebhook
    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"
Navigation