RisingWave Events API

The Events API from RisingWave — 1 operation(s) for events.

OpenAPI Specification

risingwave-events-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: RisingWave Events API
  version: '1.0'
  description: HTTP API for real-time event ingestion and SQL query execution against a running RisingWave instance. Supports inserting events into streaming tables and running PostgreSQL-compatible SQL queries.
  contact:
    name: RisingWave Labs
    url: https://risingwave.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: /v1
  description: Base API path
tags:
- name: Events
paths:
  /events:
    post:
      summary: Ingest a new event
      operationId: ingestEvent
      description: Ingest a JSON event payload into the specified RisingWave table. The target table must exist and the payload keys should correspond to column names.
      parameters:
      - in: query
        name: name
        schema:
          type: string
        required: true
        description: Name of the table to ingest the event into
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Arbitrary JSON object representing the event payload
            example:
              user_id: u-42
              event_type: page_view
              url: /docs/intro
              ts: 1717200000000
      responses:
        '201':
          description: Event ingested successfully
        '400':
          description: Bad request — malformed JSON or missing table name
        '500':
          description: Internal server error
      tags:
      - Events
externalDocs:
  description: RisingWave Documentation
  url: https://docs.risingwave.com