Humanitec Event API is one of 45 APIs that Humanitec publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Event. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.
This API exposes
7 operations
across 4 paths,
and defines 9 schemas.
It is described by OpenAPI 3.0.0, at version 0.28.24.
Requests are made against a single base URL, https://api.humanitec.io/.
7 operations4 paths9 schemas2 DELETE3 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Across 4 paths, the API surfaces 7 operations — 2 DELETE, 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Event 7
Webhook is a special type of a Job. It performs an HTTPS request to a specified URL with specified headers.
DELETE
/orgs/{orgId}/apps/{appId}/jobs
Deletes all Jobs for the Application
2 params→ 204
GET
/orgs/{orgId}/apps/{appId}/webhooks
List Webhooks
2 params→ 200
POST
/orgs/{orgId}/apps/{appId}/webhooks
Create a new Webhook
2 paramsbody→ 201400409
GET
/orgs/{orgId}/apps/{appId}/webhooks/{jobId}
Get a Webhook
3 params→ 200404
DELETE
/orgs/{orgId}/apps/{appId}/webhooks/{jobId}
Delete a Webhook
3 params→ 204404
PATCH
/orgs/{orgId}/apps/{appId}/webhooks/{jobId}
Update a Webhook
3 paramsbody→ 200400404
GET
/orgs/{orgId}/events
List Events
1 param→ 200
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are WebhookResponse (8 properties), WebhookRequest (6 properties), WebhookUpdateResponse (5 properties), HumanitecErrorResponse (3 properties). Each schema is shown below with its type and property counts.
JSONFieldRequest
object
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties2 required
EventBaseRequest
object
Properties which identify an event .
2 properties
WebhookResponse
object
Webhook is a special type of a Job. It performs an HTTPS request to a specified URL with specified headers.
8 properties6 required
JSONFieldResponse
object
WebhookRequest
object
Webhook is a special type of a Job. It performs an HTTPS request to a specified URL with specified headers.
6 properties
WebhookUpdateResponse
object
Webhook is a special type of a Job. It performs an HTTPS request to a specified URL with specified headers.
5 properties5 required
EventResponse
object
Events available for triggering automated jobs.
3 properties3 required
EventBaseResponse
object
Properties which identify an event .
2 properties2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
