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

The SNS API from Hatchet — 2 operation(s) for sns.

Hatchet SNS 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 SNS. 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 3 operations across 2 paths, and defines 7 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.

3 operations 2 paths 7 schemas 1 DELETE1 GET1 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 SNS 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 3

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

SNS 3
GET
/api/v1/tenants/{tenant}/sns
List SNS Integrations
sns:list 1 param → 200400401405
POST
/api/v1/tenants/{tenant}/sns
Create SNS Integration
sns:create 1 param body → 201400401405
DELETE
/api/v1/sns/{sns}
Delete SNS Integration
sns:delete 1 param → 204400401405

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are APIError (4 properties), SNSIntegration (4 properties), APIResourceMeta (3 properties), PaginationResponse (3 properties). Each schema is shown below with its type and property counts.

PaginationResponse
object
3 properties
CreateSNSIntegrationRequest
object
1 property 1 required
ListSNSIntegrations
object
2 properties 2 required
APIResourceMeta
object
3 properties 3 required
APIErrors
object
1 property 1 required
SNSIntegration
object
4 properties 3 required
APIError
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hatchet-sns-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