- Human-in-the-loop workflows (approvals, reviews, manual steps)
- External system integration (waiting for webhooks, async APIs)
- AI agent patterns (tool execution, human oversight)
Two Approaches
Restate provides two primitives for handling external events:Primitive | Use Case | Key Feature |
---|---|---|
Awakeables | Services & Virtual Objects | Unique ID-based completion |
Durable Promises | Workflows only | Named promises for simpler signaling |
How it works
Implementing this pattern in a distributed system is tricky, since you need to ensure that the handler can recover from failures and resume waiting for the external event. Restate makes promises are durable and distributed. They survive crashes and can be resolved or rejected by any handler in the workflow. To save costs on FaaS deployments, Restate lets the handler suspend while awaiting the promise, and invokes it again when the result is available.Awakeables
Best for: Services and Virtual Objects where you need to coordinate with external systems.Creating and waiting for awakeables
- Create an awakeable - Get a unique ID and promise
- Send the ID externally - Pass the awakeable ID to your external system
- Wait for result - Your handler suspends until the external system responds
Serialization
Serialization
You can resolve an awakeable with any payload that can be serialized. By default,
serialization is done with
JSONCodec
which uses encoding/json
. If you don’t need to provide anything, you can
use restate.Void{}
which serializes to a nil byte slice.Note that if you wait for an awakeable in an exclusive handler in a Virtual Object, all other calls to this object will be queued.
Resolving/rejecting Awakeables
External processes complete awakeables in two ways:- Resolve with success data → handler continues normally
- Reject with error reason → throws a terminal error in the waiting handler
Via SDK (from other handlers)
Resolve:Via HTTP API
External systems can complete awakeables using Restate’s HTTP API: Resolve with data:Durable Promises
Best for: Workflows where you need to signal between different workflow handlers. Key differences from awakeables:- No ID management - use logical names instead
- Scoped to workflow execution lifetime
- Sending data to the run handler
- Have handlers wait for events emitted by the run handler
After a workflow’s run handler completes, other handlers can still be called for up to 24 hours (default).
The results of resolved Durable Promises remain available during this time.
Update the retention time via the service configuration.
Creating and waiting for promises
Wait for a promise by name:Resolving/rejecting promises
Resolve/reject from any workflow handler:Complete workflow example
Two signaling patterns
External → Workflow (shown above): External handlers signal the run handler- Use for human approvals, external API responses, manual interventions
- External handlers call the handler which resolves the promise
- Use for step completion notifications, status updates, result broadcasting
- Run handler resolves promises that external handlers are awaiting
Best Practices
- Use awakeables for services/objects coordinating with external systems
- Use durable promises for workflow signaling
- Always handle rejections to gracefully manage failures
- Include timeouts for long-running external processes