OrbexStream

Configure source connections and stream sessions, then inspect the session status and the configured destination.

Open OrbexStream

Configure a streaming workflow

  1. Open Connections to configure and test the source, or use the source setup offered by the stream workflow.
  2. Choose the supported source and target types displayed by that form. Provide the required endpoint, bucket, database, or webhook settings.
  3. Create a session and inspect its returned state. Check the destination for actual records.
  4. Use the session’s available start or stop control, and inspect errors before retrying.

Sessions and providers

The session creation API accepts streamName, sourceType, sourceConfig, targetType, and targetConfig. Its source enum is weather-api, iot-sensor, api-webhook, or database; targets are orbex-bucket, database, or webhook.

Other streaming tools, including Kafka-related setup, have separate configurations. A session form or stored record does not establish universal Kafka compatibility, pause/resume support, or successful live data delivery.

Validate the output

Use the stream and session IDs returned by the selected API. Review source errors and actual destination content. Polling, batching, and execution lifetime depend on the selected source and runtime.

API endpoints

Use your Genorbex deployment’s origin followed by the path below. Replace IDs with resources accessible to your account. Authentication and permissions are checked by each endpoint.

GET /api/orbexstream/sessions

Lists visible streaming sessions.

Authentication: Genorbex account token and service/resource access; API-key support follows the endpoint’s authentication guard.

POST /api/orbexstream/sessions

Creates a session using its validated source and target configuration.

Authentication: Genorbex account token and service/resource access; API-key support follows the endpoint’s authentication guard.

DELETE /api/orbexstream/sessions/{sessionId}

Deletes a stopped session owned by the current account. Read current session state from the session list.

Authentication: Genorbex account token and service/resource access; API-key support follows the endpoint’s authentication guard.

POST /api/orbexstream/sessions/{sessionId}/stop

Requests that the selected session stop.

Authentication: Genorbex account token and service/resource access; API-key support follows the endpoint’s authentication guard.

Need help with your setup? Visit the Help Center or contact Genorbex.