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

Red Hat Notifications API

API for managing notification preferences, integrations, and event routing within the Hybrid Cloud Console, enabling alerts through email, webhook, and third-party services.

This event API exposes 8 operations across 8 channels, and defines 17 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.

The API connects through a single server, https://console.redhat.com (https).

8 operations 8 channels 17 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0
Server
https://console.redhat.com (https)
Resource Areas
1

Channels & Operations 8

Across 8 channels, the API surfaces 8 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 8
SUB
advisor.newRecommendation
New advisor recommendation
onAdvisorNewRecommendation body
SUB
advisor.resolvedRecommendation
Advisor recommendation resolved
onAdvisorResolvedRecommendation body
SUB
vulnerability.newCve
New CVE detected
onVulnerabilityNewCve body
SUB
vulnerability.cveSeverityChange
CVE severity changed
onVulnerabilityCveSeverityChange body
SUB
compliance.policyViolation
Compliance policy violation
onCompliancePolicyViolation body
SUB
patch.newAdvisory
New patch advisory
onPatchNewAdvisory body
SUB
inventory.systemRegistered
System registered
onInventorySystemRegistered body
SUB
inventory.systemBecameStale
System became stale
onInventorySystemBecameStale body

Messages & Schemas 17

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

AdvisorRecommendationEvent
message
A new Advisor recommendation was identified for systems.
AdvisorResolvedEvent
message
An Advisor recommendation was resolved.
VulnerabilityNewCveEvent
message
A new CVE was detected affecting systems.
VulnerabilitySeverityChangeEvent
message
A CVE severity rating was changed.
CompliancePolicyViolationEvent
message
A compliance policy violation was detected.
PatchNewAdvisoryEvent
message
New patch advisories are available for systems.
InventorySystemRegisteredEvent
message
A new system was registered with Insights.
InventorySystemStaleEvent
message
A system became stale after missing check-ins.
NotificationEventBase
object
Base structure shared by all Hybrid Cloud Console notification event payloads.
8 properties 7 required
AdvisorRecommendationPayload
object
AdvisorResolvedPayload
object
VulnerabilityNewCvePayload
object
VulnerabilitySeverityChangePayload
object
CompliancePolicyViolationPayload
object
PatchNewAdvisoryPayload
object
InventorySystemRegisteredPayload
object
InventorySystemStalePayload
object

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

red-hat-notifications-webhooks-asyncapi.yml Raw ↑