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 Webhook API

The Webhook API from Hatchet — 2 operation(s) for webhook.

Hatchet Webhook 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 Webhook. 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 6 operations across 2 paths, and defines 26 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.

6 operations 2 paths 26 schemas 1 DELETE2 GET1 PATCH2 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 Webhook 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 6

Across 2 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Webhook 6
GET
/api/v1/stable/tenants/{tenant}/webhooks
List Webhooks
v1-webhook:list 5 params → 200400403
POST
/api/v1/stable/tenants/{tenant}/webhooks
Create a Webhook
v1-webhook:create 1 param body → 200400403404
GET
/api/v1/stable/tenants/{tenant}/webhooks/{v1-webhook}
Get a Webhook
v1-webhook:get 2 params → 200400403
DELETE
/api/v1/stable/tenants/{tenant}/webhooks/{v1-webhook}
Delete a webhook
v1-webhook:delete 2 params → 200400403404
POST
/api/v1/stable/tenants/{tenant}/webhooks/{v1-webhook}
Post a Webhook Message
v1-webhook:receive 2 params body → 200204400403
PATCH
/api/v1/stable/tenants/{tenant}/webhooks/{v1-webhook}
Update a Webhook
v1-webhook:update 2 params body → 200400403404

Schemas 26

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

V1WebhookAuthType
string
TenantEnvironment
string
V1CreateWebhookRequestBase
object
6 properties 3 required
Tenant
object
9 properties 4 required
APIResourceMeta
object
3 properties 3 required
V1Webhook
object
9 properties 6 required
V1CreateWebhookRequestAPIKey
V1WebhookAPIKeyAuth
object
2 properties 2 required
APIError
object
4 properties 1 required
V1CreateWebhookRequestBasicAuth
PaginationResponse
object
3 properties
V1WebhookSourceName
string
V1CreateWebhookRequestHMAC
V1WebhookHMACEncoding
string
V1Event
object
11 properties 4 required
V1WebhookHMACAuth
object
4 properties 4 required
V1WebhookResponse
object
3 properties
V1CreateWebhookRequest
V1WebhookBasicAuth
object
2 properties 2 required
V1WebhookList
object
2 properties
APIErrors
object
1 property 1 required
TenantVersion
string
V1EventWorkflowRunSummary
object
5 properties 5 required
V1EventTriggeredRun
object
2 properties 1 required
V1UpdateWebhookRequest
object
4 properties
V1WebhookHMACAlgorithm
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hatchet-webhook-api-openapi.yml Raw ↑

Other APIs Hatchet publishes across the network.

Hatchet API Token API
Hatchet CEL API
Hatchet Durable Tasks API
Hatchet Event 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