prefect.cli.events

Events command — native cyclopts implementation.

Stream and emit events.

Functions

stream ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/events.py#L30" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

stream()

Subscribe to the event stream, printing each event as it is received.

emit ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/events.py#L112" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

emit(event: str)

Emit a single event to Prefect.

Examples:

# Simple event with resource ID
$ prefect event emit user.logged_in --resource-id user-123

# Event with payload
$ prefect event emit order.shipped --resource-id order-456 --payload '{"tracking": "ABC123"}'

# Event with full resource specification
$ prefect event emit customer.subscribed --resource '{"prefect.resource.id": "customer-789", "prefect.resource.name": "ACME Corp"}'