Confluent User Notifications (notifications/v1) API
[](#section/Versioning/API-Lifecycle-Policy) [](mailto:ccloud-api-access+notifications-v1-early-access@confluent.io?subject=Request%20to%20join%20notifications/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20notifications/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E.)`UserNotification` objects represent in-app notifications scoped to a specificConfluent Cloud user. Each notification carries a severity, references theConfluent Cloud resource it relates to, and tracks whether the user has read it.This API lets you list and retrieve your notifications, mark notifications asread or unread, and fetch an unread-count summary.`read` is the only mutable field on this resource; `PATCH` requests with valuesfor other fields will have those values silently ignored.Two `PATCH` shapes are supported:- `PATCH /user-notifications/{id}` — update a single notification by id.- `PATCH /user-notifications` — update the read state of every notification matching the supplied filter query parameters. The body is a narrow payload (`{ "read": true | false }`) and the same filters accepted by the list endpoint scope which notifications are updated (with the exception of `include`, which is a list-only partial-response selector).The heavier `integrations` and `recommended_actions` fields are populated onsingle-resource reads (`GET /user-notifications/{id}`) and omitted from listresponses by default to keep collection payloads slim. Use the `include`query parameter on the list endpoint to opt in to populating these fields(`?include=integrations,recommended_actions`).Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/current/monitoring/configure-notifications.html#notifications-for-ccloud).## The User Notifications Model
Confluent User Notifications (notifications/v1) API is one of 127 APIs that Confluent publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include User Notifications (notifications/v1). The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 5 operations across 4 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0.
Requests are made against a single base URL, https://api.confluent.cloud.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 6
Confluent User Notifications (notifications/v1) API declares
6 security schemes
for authenticating requests.
It accepts HTTP basic authentication (cloud-api-key).
It supports OAuth 2.0 (confluent-sts-access-token) using the clientCredentials flow.
It accepts HTTP basic authentication (global-api-key).
It accepts HTTP basic authentication (resource-api-key).
It supports OAuth 2.0 (external-access-token) using the clientCredentials flow.
It supports OAuth 2.0 (oauth) using the clientCredentials flow, exposing 4 scopes.
cloud-api-key— Authenticate with Cloud API Keys using HTTP Basic Auth. Treat the Cloud API Key ID as the username and Cloud API Key Secret as the password.confluent-sts-access-token— Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.global-api-key— Authenticate with Global API Keys using HTTP Basic Auth. Treat the Global API Key ID as the username and Global API Key Secret as the password.resource-api-key— Authenticate with resource-specific API Keys using HTTP Basic Auth. Treat the resource-specific API Key ID as the username and resource-specific API Key Secret…external-access-token— Authenticate with Confluent API using this credentials (JSON Web Tokens) following OAuth 2.0.oauth— Authenticate with OAuth 2.0. Currently this is only supported for partner APIs.
Paths & Operations 5
Across 4 paths, the API surfaces 5 operations — 3 GET, 2 PATCH. Each is listed below with its method, path, parameters, and response codes.
[](section/Versioning/API-Lifecycle-Policy) [![Request Access To User Notifications API v1]…
Schemas 24
The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are notifications.v1.UserNotification (13 properties), notifications.v1.NotificationType (11 properties), Error (8 properties), notifications.v1.Integration (7 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Confluent 12
Other APIs Confluent publishes across the network.
This is an independent, third-party profile of Confluent User Notifications (notifications/v1) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.