Send Events

Three ways to send Vision Events from your deployed models.

Send Events

You can send Vision Events using a Workflow block, the REST API, or edge device backup.

  • Workflow Block - Workflows users will probably find it easiest to use the official Roboflow block

  • REST API - Users choosing to deploy models outside of workflows can use our REST API

  • Edge Device Backup - Users deploying Roboflow Edge devices will find it most convenient to configure automated backup from the local event store on device

Workflow Block

The recommended approach for most users. Add the Vision Event block to any Roboflow Workflow to automatically create events from inference results with no code needed.

Setup

1

Open the Workflow Editor

Navigate to Workflows in your workspace and open the workflow you want to add events to.

2

Add the Vision Event Block

Search for "Vision Event" in the block catalog and add it to your workflow.

3

Connect Inputs

Connect the image input and model prediction outputs to the Vision Event block.

4

Configure the Use Case

Set the Use Case name (useCaseId). You can also map custom metadata from upstream blocks.

5

Deploy the Workflow

Deploy or update your workflow. Events are created automatically each time the workflow runs.

circle-info

The Workflow block handles image upload and event creation in a single step.

REST API

For custom integrations or pipelines not using Workflows, you can send events directly via the REST API.

Authentication

All write endpoints require an API key with visionEvents.write or device.update scope. Pass the API key as a Bearer token:

End-to-End Example: Upload Image + Create Event

circle-exclamation

When sending events via the API, you first upload the image, then create the event referencing the uploaded image.

Step 1: Upload the image

Response:

Step 2: Create the event, referencing the uploaded image

Response:

Batch Create Events

Send up to 100 events in a single request using the batch endpoint:

circle-info

Maximum 100 events per batch request.

Edge Device Backup

For enterprise deployments where connectivity may be intermittent, the edge device stores events locally and syncs them to Roboflow when connectivity is restored.

circle-info

Edge Device Backup requires Deployment Manager. See the Deployment Manager documentation for setup instructions.

To enable Vision Events backup:

  1. Open Deployment Manager in your workspace

  2. Select the device to configure

  3. Enable Vision Events Backup in the device's Event Store configuration

  4. Events are written to the local event store on the device

  5. When the device reconnects, events sync to Roboflow automatically

Events appear in the Vision Events dashboard after sync completes.

Last updated

Was this helpful?