Skip to content

Roboflow Vision Events

Class: RoboflowVisionEventsBlockV1

Source: inference.core.workflows.core_steps.sinks.roboflow.vision_events.v1.RoboflowVisionEventsBlockV1

Send images, model predictions, and event metadata to the Roboflow Vision Events API for monitoring, quality control, safety alerting, and custom event tracking.

How This Block Works

This block uploads workflow images and model predictions to the Roboflow Vision Events API, creating structured events that can be queried, filtered, and visualized in the Roboflow dashboard.

  1. Optionally uploads an input image and/or output image (visualization) to the Vision Events image storage via the public API
  2. Converts model predictions (object detection, classification, instance segmentation, or keypoint detection) into the Vision Events annotation format and attaches them to the input image
  3. Creates a vision event with the specified event type, use case, event data, and custom metadata
  4. Supports fire-and-forget mode for non-blocking execution

Deployment Modes

By default this block sends events to the Roboflow Vision Events API (cloud / Serverless API), uploading images and posting the event over the public API.

For edge deployments, enable Write to Local Event Store to send events to a local Event Ingestion Service instead. In this mode images are embedded directly in the request (no upload step) and the event is posted to <event store URL>/v2/events. The event store URL defaults to http://localhost:8001 and can be overridden. No Roboflow API key is required in this mode; if the local service requires authentication, set the EVENT_INGESTION_API_KEY environment variable on the inference server.

Event Types

  • quality_check: Manufacturing/inspection QA with pass/fail result and optional confidence
  • inventory_count: Inventory tracking with location, item count, and item type
  • safety_alert: Safety violations with alert type, severity (low/medium/high), and description
  • custom: User-defined events with a free-form value string
  • operator_feedback: Operator review/correction of previous events (correct/incorrect/inconclusive)

Requirements

The default (cloud) mode requires a valid Roboflow API key with vision-events:write scope, configured in your environment or workflow configuration. No Roboflow API key is needed when Write to Local Event Store is enabled (see Deployment Modes above).

Common Use Cases

  • Quality Control: Automatically log inspection results with images and detection overlays
  • Safety Monitoring: Send safety alerts when violations are detected in video streams
  • Production Analytics: Track inventory counts and production metrics with visual evidence
  • Active Monitoring: Fire-and-forget event logging from real-time video processing workflows

Type identifier

Use the following identifier in step "type" field: roboflow_core/roboflow_vision_events@v1to add the block as as step in your workflow.

Properties

Name Type Description Refs
name str Enter a unique identifier for this step.. ❌
event_type str The type of vision event to create.. ✅
solution str The use case to associate the event with. Events are namespaced by use case within a workspace.. ✅
external_id str External identifier for correlation with other systems (max 1000 chars).. ✅
qc_result str Quality check result: pass or fail.. ✅
location str Location identifier for inventory count.. ✅
item_count int Number of items counted.. ✅
item_type str Type of item being counted.. ✅
alert_type str Alert type identifier (e.g. no_hardhat, spill_detected).. ✅
severity str Severity level for the safety alert.. ✅
alert_description str Description of the safety alert.. ✅
custom_value str Arbitrary value for custom events.. ✅
related_event_id str The event ID of the event being reviewed.. ✅
feedback str Operator feedback on the related event.. ✅
custom_metadata Dict[str, Union[bool, float, int, str]] Flat key-value metadata to attach to the event. Keys must match pattern [a-zA-Z0-9_ -]+ (max 100 chars). String values max 1000 chars.. ✅
fire_and_forget bool If True, the event is sent asynchronously and the workflow continues without waiting. If False, the block waits for the API response.. ✅
disable_sink bool If True, the block is disabled and no events are sent.. ✅
write_to_event_store bool If True, send the event to a local Event Ingestion Service (edge deployment) instead of the Roboflow Vision Events API (cloud). Images are embedded in the request and the event is posted to <Event Store URL>/v2/events. No Roboflow API key is required in this mode.. ✅
event_store_url str Base URL of the local Event Ingestion Service. Only used when Write to Local Event Store is enabled.. ✅

The Refs column marks possibility to parametrise the property with dynamic values available in workflow runtime. See Bindings for more info.

Available Connections

Compatible Blocks

Check what blocks you can connect to Roboflow Vision Events in version v1.

Input and Output Bindings

The available connections depend on its binding kinds. Check what binding kinds Roboflow Vision Events in version v1 has.

Bindings

  • input

    • input_image (image): The original input image. Uploaded to the Vision Events API and used as the base image for detection annotations..
    • output_image (image): An optional output/visualized image (e.g., from a visualization block). Displayed as the primary image in the Vision Events dashboard..
    • predictions (Union[object_detection_prediction, instance_segmentation_prediction, keypoint_detection_prediction, classification_prediction]): Optional model predictions to include as detection annotations on the input image. Supports object detection, instance segmentation, keypoint detection, and classification predictions..
    • event_type (string): The type of vision event to create..
    • solution (Union[string, roboflow_solution]): The use case to associate the event with. Events are namespaced by use case within a workspace..
    • external_id (string): External identifier for correlation with other systems (max 1000 chars)..
    • qc_result (string): Quality check result: pass or fail..
    • location (string): Location identifier for inventory count..
    • item_count (integer): Number of items counted..
    • item_type (string): Type of item being counted..
    • alert_type (string): Alert type identifier (e.g. no_hardhat, spill_detected)..
    • severity (string): Severity level for the safety alert..
    • alert_description (string): Description of the safety alert..
    • custom_value (string): Arbitrary value for custom events..
    • related_event_id (string): The event ID of the event being reviewed..
    • feedback (string): Operator feedback on the related event..
    • custom_metadata (*): Flat key-value metadata to attach to the event. Keys must match pattern [a-zA-Z0-9_ -]+ (max 100 chars). String values max 1000 chars..
    • fire_and_forget (boolean): If True, the event is sent asynchronously and the workflow continues without waiting. If False, the block waits for the API response..
    • disable_sink (boolean): If True, the block is disabled and no events are sent..
    • write_to_event_store (boolean): If True, send the event to a local Event Ingestion Service (edge deployment) instead of the Roboflow Vision Events API (cloud). Images are embedded in the request and the event is posted to <Event Store URL>/v2/events. No Roboflow API key is required in this mode..
    • event_store_url (string): Base URL of the local Event Ingestion Service. Only used when Write to Local Event Store is enabled..

  • output

    • error_status (boolean): Boolean flag.
    • event_id (string): String value.
    • message (string): String value.
Example JSON definition of step Roboflow Vision Events in version v1 
{
    "name": "<your_step_name_here>",
    "type": "roboflow_core/roboflow_vision_events@v1",
    "input_image": "$inputs.image",
    "output_image": "$steps.visualization.image",
    "predictions": "$steps.object_detection_model.predictions",
    "event_type": "quality_check",
    "solution": "my-use-case",
    "external_id": "batch-2025-001",
    "qc_result": "pass",
    "location": "warehouse-A",
    "item_count": 42,
    "item_type": "widget",
    "alert_type": "no_hardhat",
    "severity": "high",
    "alert_description": "Worker detected without hardhat in zone B",
    "custom_value": "anomaly detected at 14:32",
    "related_event_id": "evt_abc123",
    "feedback": "correct",
    "custom_metadata": {
        "camera_id": "cam_01",
        "location": "$inputs.location"
    },
    "fire_and_forget": true,
    "disable_sink": false,
    "write_to_event_store": false,
    "event_store_url": "http://localhost:8001"
}