Skip to main content
Work pool and work queue events track readiness status transitions and field updates. These events are emitted server-side. For more on work pools, see Work pools.

Work pool events

prefect.work-pool.{status}

Emitted when a work pool’s status transitions.

Status variants

Event nameDescription
prefect.work-pool.readyWork pool is ready to accept work
prefect.work-pool.not-readyWork pool is not ready (for example, no online workers)
prefect.work-pool.pausedWork pool has been paused

Resource

LabelDescription
prefect.resource.idprefect.work-pool.{uuid}
prefect.resource.nameWork pool name
prefect.work-pool.typeWork pool type (for example, kubernetes, process, docker)
This event has no related resources.

Payload

This event has no payload.

prefect.work-pool.updated

Emitted when one or more work pool fields are changed (excluding status transitions, which emit prefect.work-pool.{status} instead).

Resource

LabelDescription
prefect.resource.idprefect.work-pool.{uuid}
prefect.resource.nameWork pool name
prefect.work-pool.typeWork pool type
This event has no related resources.

Payload

FieldTypeDescription
updated_fieldsarray of stringsNames of fields that changed
updatesobjectMap of field name to {"from": <old>, "to": <new>}

Work queue events

prefect.work-queue.{status}

Emitted when a work queue’s status transitions.

Status variants

Event nameDescription
prefect.work-queue.readyWork queue is ready to dispatch work
prefect.work-queue.not-readyWork queue is not ready
prefect.work-queue.pausedWork queue has been paused

Resource

LabelDescription
prefect.resource.idprefect.work-queue.{uuid}
prefect.resource.nameWork queue name
Resource ID patternRoleWhen present
prefect.work-pool.{uuid}work-poolWhen the work queue belongs to a work pool (includes prefect.work-pool.type label)

Payload

This event has no payload.

prefect.work-queue.updated

Emitted when one or more work queue fields are changed (excluding status transitions).

Resource

LabelDescription
prefect.resource.idprefect.work-queue.{uuid}
prefect.resource.nameWork queue name
Resource ID patternRoleWhen present
prefect.work-pool.{uuid}work-poolWhen the work queue belongs to a work pool (includes prefect.work-pool.type label)

Payload

FieldTypeDescription
updated_fieldsarray of stringsNames of fields that changed
updatesobjectMap of field name to {"from": <old>, "to": <new>}