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

KEDA CloudEventSource API

The CloudEventSource and ClusterCloudEventSource custom resources define HTTP or Azure Event Grid destinations where KEDA delivers CloudEvents when scaling events occur. Events follow the CloudEvents specification v1.0 and carry reason codes and messages for events such as ScalerError, ScaledObjectReady, ScaledObjectDeleted, and AuthenticationFailed. Optional event type filters allow consumers to subscribe to only the events they care about.

KEDA CloudEventSource API is one of 5 APIs that KEDA publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

This API exposes 1 JSON Schema definition.

Tagged areas include CloudEvents, CRD, Events, Kubernetes, and Webhooks. The published artifact set on APIs.io includes API documentation, an AsyncAPI specification, and 1 JSON Schema.

This event API exposes 1 operation across 1 channel, and defines 8 schemas. It is described by AsyncAPI 2.6.0, at version 2.x.

The API connects through a single server, {sinkUrl} (https).

1 operations 1 channels 8 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
2.x
Server
{sinkUrl} (https)
License
Resource Areas
1

Channels & Operations 1

Across 1 channel, the API surfaces 1 operation. Each is listed below with its action, channel, parameters, and response codes.

Channels 1
PUB
/events
Receive a KEDA CloudEvent
receiveKedaCloudEvent body

Messages & Schemas 8

The contract defines 8 schemas that model the data carried by its messages. The most detailed are KedaCloudEvent (8 properties), KedaEventData (2 properties). Each schema is shown below with its type and property counts.

ScalerErrorEvent
message
A KEDA scaler encountered an error retrieving metrics
ScaledObjectReadyEvent
message
A ScaledObject has been successfully created and is active
ScaledObjectDeletedEvent
message
A ScaledObject has been deleted
ScaledJobReadyEvent
message
A ScaledJob has been successfully created and is active
ScaledJobDeletedEvent
message
A ScaledJob has been deleted
AuthenticationFailedEvent
message
A TriggerAuthentication credential check failed
KedaCloudEvent
object
A CloudEvent (v1.0) emitted by KEDA when a scaling-related event occurs. Follows the CloudEvents specification envelope with a KEDA-specific data payload conta…
8 properties 8 required
KedaEventData
object
The payload of a KEDA CloudEvent containing the reason code and human-readable message describing the scaling event.
2 properties 2 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

keda-cloud-events-asyncapi.yml Raw ↑

Other APIs KEDA publishes across the network.

KEDA Metrics API
KEDA ScaledObject API
KEDA ScaledJob API
KEDA TriggerAuthentication API