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

Kubeshop webhook API

Webhook operations

Kubeshop webhook API is one of 30 APIs that Kubeshop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include webhook. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against 2 base URLs: https://api.testkube.io, https://.

6 operations 2 paths 14 schemas 2 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.testkube.io
License
Resource Areas
1

Paths & Operations 6

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

webhook 6

Webhook operations

GET
/webhooks
List webhooks
listWebhooks 1 param → 200400502
POST
/webhooks
Create new webhook
createWebhook body → 200201400502
DELETE
/webhooks
Delete webhooks
deleteWebhooks 1 param → 204502
DELETE
/webhooks/{id}
Delete webhook
deleteWebhook 1 param → 204404502
GET
/webhooks/{id}
Get webhook details
getWebhook 1 param → 200400404500502
PATCH
/webhooks/{id}
Update new webhook
updateWebhook 1 param body → 200400404502

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Webhook (19 properties), WebhookParameterSchema (6 properties), Problem (5 properties), ExecutionTarget (3 properties). Each schema is shown below with its type and property counts.

WebhookUpdateRequest
object
webhook update request body
Syncable
object
source information about resources that may have been synced from multiple sources. An empty source indicates that the source was the UI/API for backwards comp…
2 properties
Webhook
object
CRD based webhook data
19 properties 1 required
Source
string
synchronisation sources
EventType
string
SecretRef
object
Testkube internal reference for secret storage in Kubernetes secrets
3 properties 2 required
WebhookConfig
object
configuration values
WebhookCreateRequest
object
webhook create request body
Problem
object
problem response in case of error
5 properties
WebhookTemplateRef
object
1 property 1 required
ExecutionTarget
object
3 properties
BoxedString
object
1 property 1 required
WebhookConfigValue
object
configuration value
2 properties
WebhookParameterSchema
object
parameter definition
6 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubeshop-webhook-api-openapi.yml Raw ↑

Other APIs Kubeshop publishes across the network.

Kubeshop api API
Kubeshop artifacts API
Kubeshop cluster-resources API
Kubeshop Executions API
Kubeshop executor API
Kubeshop keymap API
Kubeshop labels API
Kubeshop logs API
Kubeshop Organizations API
Kubeshop pro API
Kubeshop repository API
Kubeshop secrets API