Ruby SDK
Ruby SDK
This is the generated API reference for the Hatchet Ruby SDK. For concepts and guides, see the user guide.
Core pages
- Client: The main Hatchet client, its configuration, and the feature client accessors
- Context: The context object passed to tasks at runtime
- Runnables: Tasks and workflows, the objects you register on workers and run
Feature clients
Feature clients are available as methods on the client, and each covers one area of the Hatchet API. The Guide column links to the user guide page for the feature.
| Client | Description | Guide |
|---|---|---|
| CEL | Evaluate and debug CEL expressions used in event filters and concurrency keys | |
| Crons | Create and manage cron triggers that run workflows on a schedule | Cron Runs |
| Events | Push events and inspect event history | Events |
| Filters | Manage event filters that scope which events trigger runs | Events |
| Logs | Read logs written by task runs | Logging |
| Metrics | Read queue depths, task status counts, and tenant Prometheus metrics | Prometheus Metrics |
| Rate Limits | Create and inspect rate limits that control task throughput | Rate Limits |
| Runs | Get, replay, cancel, and inspect workflow runs and their results | Running Tasks |
| Scheduled Runs | Schedule workflow runs for a specific future time | Scheduled Runs |
| Tenant | Read details about the current tenant | |
| Workers | List workers and manage their state | Workers |
| Workflows | List and manage registered workflow definitions | Tasks |
Last updated on September 3, 2026