Skip to main content

Receiver

Webhook receiver for external events.

  • Group: notification.toolkit.fluxcd.io
  • Version: v1

Fields

FieldLabelTypeRequiredDescription
metadata.nameNamestringYesUnique name for this Receiver resource.
metadata.namespaceNamespacestringYesNamespace where the resource will be created.
spec.typeReceiver TypestringYesType of webhook receiver (github, gitlab, bitbucket, etc.).
spec.eventsEventsarray[string]YesList of webhook events to listen for (e.g., push, pull_request, merge) that trigger reconciliation of the specified resources.
spec.resourcesResourcesarray[object]YesFluxCD resources to reconcile when webhook is triggered.
spec.secretRef.nameSecret NamestringYesSecret containing webhook validation token.

Example

apiVersion: notification.toolkit.fluxcd.io/v1
kind: Receiver
metadata:
name: example
namespace: flux-system
spec:
type: github
events:
- 'ping'
- 'push'
secretRef:
name: webhook-token
resources:
- kind: GitRepository
name: webapp