> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kapso.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List notification event types

> The catalog of events you can route, ordered by category and name. Use `key` when
creating a route. Internal events such as the test notification are not listed.




## OpenAPI

````yaml /api/platform/v1/openapi-platform.yaml get /notifications/events
openapi: 3.1.0
info:
  title: Kapso Platform API
  version: 0.2.0
  description: >
    Build WhatsApp messaging into your product. Manage customers, connect phone
    numbers, send broadcasts, and handle conversations.
servers:
  - url: https://api.kapso.ai/platform/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Customers
    description: Manage customer accounts
  - name: Setup Links
    description: WhatsApp onboarding via embedded signup
  - name: Phone Numbers
    description: Connect and manage WhatsApp numbers
  - name: Webhooks
    description: Subscribe to WhatsApp events
  - name: Display Names
    description: Update WhatsApp business display names
  - name: Broadcasts
    description: |
      Send template messages at scale

      **Alpha**: This API is in alpha and subject to change
  - name: Conversations
    description: Manage conversation state
  - name: Media
    description: Upload media files for WhatsApp messaging
  - name: Users
    description: Manage project team members
  - name: Inbox Embeds
    description: Create and manage embeddable inbox access links
  - name: Webhook Deliveries
    description: View webhook delivery attempts and their status
  - name: External API Logs
    description: View logs of external API calls made by the project
  - name: Log Search
    description: Search log events across API, Meta, workflow, and webhook sources
  - name: Events
    description: Emit and query project-scoped events
  - name: Provider Models
    description: List available AI provider models
  - name: WhatsApp Flows
    description: Build interactive WhatsApp Flows for surveys and forms
  - name: Contacts
    description: Manage WhatsApp contacts
  - name: Findings
    description: Detect recurring problems in conversations and investigate them with AI
  - name: Notifications
    description: >-
      Route project alerts to shared inboxes and Slack channels connected from
      the Kapso app
paths:
  /notifications/events:
    get:
      tags:
        - Notifications
      summary: List notification event types
      description: >
        The catalog of events you can route, ordered by category and name. Use
        `key` when

        creating a route. Internal events such as the test notification are not
        listed.
      operationId: listNotificationEventTypes
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/NotificationEventType'
              example:
                data:
                  - key: findings.detected
                    name: New finding detected
                    description: >-
                      When Kapso detects a new finding, not each refresh of its
                      evidence.
                    category: findings
                    severity: warning
                    supported_channels:
                      - email
                      - slack
                    data_contract:
                      required: []
                      optional:
                        - title
                        - message
                        - resource_name
                        - details
                        - occurred_at
                    surface_path_template: /projects/%<project_id>s/findings
        '401':
          $ref: '#/components/responses/UnauthorizedError'
components:
  schemas:
    NotificationEventType:
      type: object
      properties:
        key:
          type: string
          description: >-
            Stable identifier used when creating routes, e.g.
            `findings.detected`.
        name:
          type: string
        description:
          type: string
        category:
          type: string
          enum:
            - account
            - billing
            - usage
            - whatsapp
            - workflow
            - agent
            - integration
            - security
            - reports
            - product
            - findings
        severity:
          type: string
          enum:
            - info
            - warning
            - error
            - critical
        supported_channels:
          type: array
          items:
            type: string
            enum:
              - email
              - slack
        data_contract:
          type: object
          description: >
            Fields the event payload may carry. Every event accepts `title`,
            `message`,

            `resource_name`, `details`, and `occurred_at`; `kapso_agent.*`
            events also carry

            `agent_run_id`.
          properties:
            required:
              type: array
              items:
                type: string
            optional:
              type: array
              items:
                type: string
        surface_path_template:
          type: string
          description: >-
            Kapso app path the notification links to, with `%<project_id>s`
            interpolated.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
  responses:
    UnauthorizedError:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````