Enum WorkflowEvent 

pub enum WorkflowEvent {
    StepStarted {
        step_name: String,
        step_index: u32,
        timestamp: DateTime<Utc>,
    },
    StepCompleted {
        step_name: String,
        step_index: u32,
        duration_ms: u64,
        output_summary: Option<String>,
    },
    StepFailed {
        step_name: String,
        step_index: u32,
        error: String,
        duration_ms: u64,
    },
    ApprovalRequired {
        step_name: String,
        step_index: u32,
        approval_id: Uuid,
    },
    AgentStepTokensUsed {
        step_name: String,
        tokens: u64,
        cost_usd: Decimal,
    },
}

A granular step-level event for real-time workflow monitoring.

Unlike Event which covers the full system lifecycle (runs, auth, audit), WorkflowEvent tracks individual step transitions within a single run. Serialized with a type discriminant for UI consumption.

Examples

use ironflow_engine::notify::WorkflowEvent;
use chrono::Utc;

let event = WorkflowEvent::StepStarted {
    step_name: "deploy".to_string(),
    step_index: 0,
    timestamp: Utc::now(),
};
assert_eq!(event.event_type(), "step_started");

let json = serde_json::to_string(&event).unwrap();
assert!(json.contains("\"type\":\"step_started\""));

Variants

StepStarted

A step began execution.

Fields

step_name: String

Human-readable step name.

step_index: u32

Zero-based position in the workflow.

timestamp: DateTime<Utc>

When the step started.

StepCompleted

A step completed successfully.

Fields

step_name: String

Human-readable step name.

step_index: u32

Zero-based position in the workflow.

duration_ms: u64

Step duration in milliseconds.

output_summary: Option<String>

Optional summary of the step output.

StepFailed

A step failed.

Fields

step_name: String

Human-readable step name.

step_index: u32

Zero-based position in the workflow.

error: String

Error description.

duration_ms: u64

Step duration in milliseconds.

ApprovalRequired

A step requires human approval before the run can continue.

Fields

step_name: String

Human-readable step name.

step_index: u32

Zero-based position in the workflow.

approval_id: Uuid

Identifier of the approval gate.

AgentStepTokensUsed

Token usage report for an agent step.

Fields

step_name: String

Human-readable step name.

tokens: u64

Total tokens consumed.

cost_usd: Decimal

Estimated cost in USD.

Implementations

impl WorkflowEvent

pub const STEP_STARTED: &'static str = "step_started"

Event type constant for StepStarted.

pub const STEP_COMPLETED: &'static str = "step_completed"

Event type constant for StepCompleted.

pub const STEP_FAILED: &'static str = "step_failed"

Event type constant for StepFailed.

pub const APPROVAL_REQUIRED: &'static str = "approval_required"

Event type constant for ApprovalRequired.

pub const AGENT_STEP_TOKENS_USED: &'static str = "agent_step_tokens_used"

Event type constant for AgentStepTokensUsed.

pub fn event_type(&self) -> &'static str

Returns the event type as a static string (e.g. "step_started").

Examples

use ironflow_engine::notify::WorkflowEvent;
use chrono::Utc;

let event = WorkflowEvent::StepStarted {
    step_name: "build".to_string(),
    step_index: 0,
    timestamp: Utc::now(),
};
assert_eq!(event.event_type(), "step_started");

Trait Implementations

impl Clone for WorkflowEvent

fn clone(&self) -> WorkflowEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WorkflowEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorkflowEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WorkflowEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.