Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hatchet Event API

The Event API from Hatchet — 11 operation(s) for event.

Hatchet Event API is one of 27 APIs that Hatchet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 12 JSON Schema definitions.

Tagged areas include Event. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, code examples, authentication docs, and 12 JSON Schemas.

This API exposes 12 operations across 11 paths, and defines 29 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against the base URL https://api.hatchet-cloud.run.

12 operations 11 paths 29 schemas 8 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.hatchet-cloud.run
Authentication
HTTP Bearer, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Hatchet Event API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the cookie as hatchet (cookieAuth). It accepts HTTP bearer tokens (customAuth). By default, every request must be authenticated.

Paths & Operations 12

Across 11 paths, the API surfaces 12 operations — 8 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Event 12
GET
/api/v1/stable/tenants/{tenant}/events
List Events
v1-event:list 11 params → 200400403
GET
/api/v1/stable/tenants/{tenant}/events/{v1-event}
Get Events
v1-event:get 2 params → 200400403
GET
/api/v1/stable/tenants/{tenant}/events/keys
List Event Keys
v1:event-key:list 1 param → 200400403
GET
/api/v1/tenants/{tenant}/events
List Events
event:list 11 params → 200400403
POST
/api/v1/tenants/{tenant}/events
Create Event
event:create 1 param body → 200400403429
POST
/api/v1/tenants/{tenant}/events/bulk
Bulk Create Events
event:create:bulk 1 param body → 200400403429
POST
/api/v1/tenants/{tenant}/events/replay
Replay Events
event:update:replay 1 param body → 200400403429
POST
/api/v1/tenants/{tenant}/events/cancel
Replay Events
event:update:cancel 1 param body → 200400403429
GET
/api/v1/events/{event}
Get Event Data
event:get 1 param → 200400403
GET
/api/v1/events/{event}/data
Get Event Data
event-data:get 1 param → 200400403
GET
/api/v1/tenants/{tenant}/events/{event-with-tenant}/data
Get Event Data
event-data:get-with-tenant 2 params → 200400403
GET
/api/v1/tenants/{tenant}/events/keys
List Event Keys
event-key:list 1 param → 200400403

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are V1Event (11 properties), Tenant (9 properties), EventWorkflowRunSummary (6 properties), Event (6 properties). Each schema is shown below with its type and property counts.

EventData
object
1 property 1 required
TenantEnvironment
string
EventKey
string
The key for the event.
Tenant
object
9 properties 4 required
APIResourceMeta
object
3 properties 3 required
APIError
object
4 properties 1 required
CreateEventRequest
object
5 properties 2 required
PaginationResponse
object
3 properties
CancelEventRequest
object
1 property 1 required
Event
object
6 properties 3 required
BulkCreateEventRequest
object
1 property 1 required
V1Event
object
11 properties 4 required
Events
object
2 properties 2 required
ReplayEventRequest
object
1 property 1 required
EventList
object
2 properties
WorkflowRunStatusList
array
EventSearch
string
APIErrors
object
1 property 1 required
WorkflowID
string
A workflow ID.
TenantVersion
string
EventOrderByDirection
string
V1EventWorkflowRunSummary
object
5 properties 5 required
WorkflowRunStatus
string
V1EventTriggeredRun
object
2 properties 1 required
V1EventList
object
2 properties
EventOrderByField
string
EventWorkflowRunSummary
object
6 properties
V1TaskStatus
string
EventKeyList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hatchet-event-api-openapi.yml Raw ↑

Other APIs Hatchet publishes across the network.

Hatchet API Token API
Hatchet CEL API
Hatchet Durable Tasks API
Hatchet Feature Flags API
Hatchet Filter API
Hatchet Github API
Hatchet Healthcheck API
Hatchet Log API
Hatchet Metadata API
Hatchet Monitoring API
Hatchet Observability API
Hatchet Rate Limits API