> ## 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.

# Emit a project event

> Stores one timestamped project event. Event names must be lowercase
dotted snake_case. `conversation_id` is optional; include it when the
event belongs to a WhatsApp conversation.




## OpenAPI

````yaml /api/platform/v1/openapi-platform.yaml post /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
paths:
  /events:
    post:
      tags:
        - Events
      summary: Emit a project event
      description: |
        Stores one timestamped project event. Event names must be lowercase
        dotted snake_case. `conversation_id` is optional; include it when the
        event belongs to a WhatsApp conversation.
      operationId: createProjectEvent
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectEventCreateRequest'
            examples:
              csat_score:
                summary: Conversation CSAT score
                value:
                  name: conversation.csat_scored
                  occurred_at: '2026-06-27T14:30:00Z'
                  conversation_id: 770e8400-e29b-41d4-a716-446655440002
                  properties:
                    score: 4
                    reason: Issue resolved in one reply
                    source: workflow
      responses:
        '201':
          description: Event created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectEventResponse'
              examples:
                created:
                  summary: Created project event
                  value:
                    data:
                      id: 990e8400-e29b-41d4-a716-446655440004
                      name: conversation.csat_scored
                      occurred_at: '2026-06-27T14:30:00Z'
                      conversation_id: 770e8400-e29b-41d4-a716-446655440002
                      properties:
                        score: 4
                        reason: Issue resolved in one reply
                        source: workflow
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '402':
          $ref: '#/components/responses/PaymentRequiredError'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    ProjectEventCreateRequest:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          description: >-
            Event name. Lowercase dotted snake_case is recommended for
            consistency.
          example: conversation.csat_scored
        occurred_at:
          type: string
          format: date-time
          description: Optional event timestamp. Defaults to the current time.
        conversation_id:
          type: string
          format: uuid
          description: Optional WhatsApp conversation ID to link to the event
        properties:
          type: object
          additionalProperties:
            oneOf:
              - type: string
              - type: number
              - type: boolean
              - type: 'null'
          description: Optional flat event properties object
    ProjectEventResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/ProjectEvent'
    ProjectEvent:
      type: object
      required:
        - id
        - name
        - occurred_at
        - conversation_id
        - properties
      properties:
        id:
          type: string
          format: uuid
          description: Unique event ID
        name:
          type: string
          description: >-
            Event name. Lowercase dotted snake_case is recommended for
            consistency.
          example: conversation.csat_scored
        occurred_at:
          type: string
          format: date-time
          description: When the event occurred
        conversation_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Linked WhatsApp conversation ID, when provided
        properties:
          type: object
          additionalProperties:
            oneOf:
              - type: string
              - type: number
              - type: boolean
              - type: 'null'
          description: Flat event properties object
    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'
    PaymentRequiredError:
      description: Feature requires a paid plan
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ValidationError:
      description: Request validation failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````