EventSubscription Configuration

Weik.io 2026.1

Configure event subscriptions to receive events from channels.

On this page

Schema properties
YAML examples
Usage notes

Defines a subscription to an event channel, enabling integration flows to receive and process events.

Schema properties#

Property	Type	Required	Default	Description
source	`string`	Yes	-	Name of the event source to subscribe to
channel	`string`	Yes	-	Name of the event channel to subscribe to

YAML examples#

Basic event subscription#

apiVersion: weik.io/v1alpha1
kind: EventSubscription
metadata:
  name: order-events-subscription
spec:
  source: order-processing
  channel: orders-channel

Multiple subscriptions#

apiVersion: weik.io/v1alpha1
kind: EventSubscription
metadata:
  name: customer-created-subscription
spec:
  source: crm-system
  channel: customer-events
---
apiVersion: weik.io/v1alpha1
kind: EventSubscription
metadata:
  name: inventory-updated-subscription
spec:
  source: inventory-system
  channel: inventory-events
---
apiVersion: weik.io/v1alpha1
kind: EventSubscription
metadata:
  name: payment-processed-subscription
spec:
  source: payment-gateway
  channel: payment-events

Database change tracking subscription#

apiVersion: weik.io/v1alpha1
kind: EventSubscription
metadata:
  name: products-table-subscription
spec:
  source: northwind-database
  channel: product-changes

External system subscription#

apiVersion: weik.io/v1alpha1
kind: EventSubscription
metadata:
  name: webhook-events-subscription
spec:
  source: external-webhooks
  channel: webhook-notifications

Usage notes#

EventSubscription configurations connect integration flows to event channels, allowing flows to react to events from various sources.

Event flow#

An event source generates events
Events are sent to an event channel
Subscribers receive events from the channel
Integration flows process the events

Source and channel references#

The source and channel properties must reference existing EventSource and EventChannel configurations. Ensure these resources are created before creating subscriptions.

Example dependency chain:

# 1. Define the event channel
apiVersion: weik.io/v1alpha1
kind: EventChannel
metadata:
  name: orders-channel
spec:
  type: memory
---
# 2. Define the event source
apiVersion: weik.io/v1alpha1
kind: EventSource
metadata:
  name: order-processing
spec:
  type: webhook
  eventType: com.example.order
  eventSource: order-api
---
# 3. Create subscription
apiVersion: weik.io/v1alpha1
kind: EventSubscription
metadata:
  name: order-subscription
spec:
  source: order-processing
  channel: orders-channel

Use cases#

Process database changes in real time
React to external webhook notifications
Trigger workflows based on system events
Implement event-driven integration patterns
Coordinate between microservices

Best practices#

Use descriptive names that indicate the event type and purpose
Create separate subscriptions for different event types
Ensure event sources and channels exist before creating subscriptions
Monitor subscription health and event processing
Handle event processing failures gracefully in your integration flows