●Change8

Migrating to Mistral Client v2.2.0rc2

Version v2.2.0rc2 introduces 2 breaking changes. This guide details how to update your code.

Released: 3/30/2026

2
Breaking Changes
3
Migration Steps
11
Affected Symbols

⚠️ Check Your Code

If you use any of these symbols, you need to read this guide:

mistral.workflows.workers.whoamimistral.workflows.events.send_eventmistral.workflows.events.send_events_batchmistral.events.send_eventmistral.events.send_events_batchmistral.workflows.events.receive_workflow_eventmistral.workflows.events.receive_workflow_events_batchmistral.events.receive_workflow_eventmistral.events.receive_workflow_events_batchmistral.workflows.executions.get_workflow_execution_historymistral.workflows.runs.get_run_history

Breaking Changes

●Issue #1

The functions `mistral.workflows.events.receive_workflow_event()`, `mistral.workflows.events.receive_workflow_events_batch()`, `mistral.events.receive_workflow_event()`, and `mistral.events.receive_workflow_events_batch()` have been removed. Consumers should migrate to the newly added send functions or use alternative event handling mechanisms.

●Issue #2

The functions for receiving workflow events have been removed, which will break existing code relying on them.

Migration Steps

  1. 1
    If you were using `mistral.workflows.events.receive_workflow_event()`, `mistral.workflows.events.receive_workflow_events_batch()`, `mistral.events.receive_workflow_event()`, or `mistral.events.receive_workflow_events_batch()`, you must find an alternative way to receive workflow events as these functions have been removed.
  2. 2
    When calling `mistral.workflows.executions.get_workflow_execution_history()`, the new optional parameter `request.decode_payloads` is now available.
  3. 3
    When calling `mistral.workflows.runs.get_run_history()`, the new optional parameter `request.decode_payloads` is now available.

Release Summary

This release introduces several new functions for sending events and worker status checks, while simultaneously removing all functions related to receiving workflow events, resulting in breaking changes.

Need More Details?

View the full release notes and all changes for Mistral Client v2.2.0rc2.

View Full Changelog