How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Confluent User Notifications (notifications/v1) API

[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) [![Request Access To User Notifications API v1](https://img.shields.io/badge/-Request%20Access%20To%20User%20Notifications%20API%20v1-%23bc8540)](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.

5 operations 4 paths 24 schemas 3 GET2 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://api.confluent.cloud
Authentication
HTTP Basic, OAuth 2.0, HTTP Basic, HTTP Basic, OAuth 2.0, OAuth 2.0
Resource Areas
1

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.

User Notifications (notifications/v1) 5

[![Early Access](https://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8)](section/Versioning/API-Lifecycle-Policy) [![Request Access To User Notifications API v1]…

GET
/notifications/v1/user-notifications
List of User Notifications
listNotificationsV1UserNotifications 10 params → 200400401403429500
GET
/notifications/v1/user-notifications/{id}
Read a User Notification
getNotificationsV1UserNotification 1 param → 200400401403404429500
PATCH
/notifications/v1/user-notifications/{id}
Update a User Notification
updateNotificationsV1UserNotification 1 param body → 200400401403404409422429
PATCH
/notifications/v1/user-notifications:mark-all
Mark multiple notifications read or unread
markAllNotificationsV1UserNotifications 6 params body → 204400401403404429500
GET
/notifications/v1/user-notifications:summary
Get notification summary
getNotificationsV1UserNotificationsSummary → 200400401403404429500

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.

notifications.v1.WebhookTarget
object
Target required for webhook integration
2 properties 2 required
notifications.v1.NotificationAction
object
A user-facing action associated with a UserNotification. The first action on a notification is treated as the primary action; subsequent actions are secondary.
3 properties 3 required
ObjectMeta
object
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
5 properties 1 required
notifications.v1.NotificationType
object
The type of notifications (and their corresponding metadata) supported by Confluent. Related guide: [Cloud Notifications](https://docs.confluent.io/cloud/curre…
11 properties
MultipleSearchFilter
array
Filter a collection by a string search for one or more values
notifications.v1.RecommendedActions
object
Versioned payload describing the recommended actions a user can take in response to a UserNotification. The shape is stable per version and consumers should br…
2 properties 2 required
notifications.v1.UserEmailTarget
object
Email integration target to send email to a particular user
2 properties 2 required
ListMeta
object
ListMeta describes metadata that resource collections may have
5 properties
notifications.v1.Integration
object
You can create an Integration to specify how we can notify you when we receive an alert/notification for a subscription. Please note that you can only perform…
7 properties
notifications.v1.SlackTarget
object
Target required for Slack integration
2 properties 2 required
notifications.v1.MsTeamsTarget
object
Target required for MS Teams integration
2 properties 2 required
notifications.v1.InAppTarget
object
Per-user in-app notification target; lazy-onboarded on first read.
2 properties 2 required
notifications.v1.UpdateUserNotificationsReadRequest
object
Request body for setting the read state on every user notification matching the supplied filter query parameters.
1 property 1 required
notifications.v1.RoleEmailTarget
object
Email integration target to send email to all user with specified role
2 properties 2 required
notifications.v1.Target
Target for the particular integration
notifications.v1.UserNotification
object
UserNotification objects represent in-app notifications scoped to a specific Confluent Cloud user. Each notification carries a severity, references the Conflue…
13 properties
notifications.v1.UserNotificationList
object
UserNotification objects represent in-app notifications scoped to a specific Confluent Cloud user. Each notification carries a severity, references the Conflue…
4 properties 4 required
notifications.v1.Summary
object
Summary of unread notifications for the authenticated user.
4 properties 4 required
SearchFilter
string
Filter a collection by a string search
BooleanFilter
boolean
Filter for whether this value is true or false.
Error
object
Describes a particular error encountered while performing an operation.
8 properties
GlobalObjectReference
object
ObjectReference provides information for you to locate the referred object
3 properties 3 required
Failure
object
Provides information about problems encountered while performing an operation.
1 property 1 required
notifications.v1.ResourceSnapshot
object
Point-in-time snapshot of the Confluent Cloud resource a UserNotification relates to. Captured at delivery; values remain stable even if the underlying resourc…
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

confluent-user-notifications-notifications-v1-api-openapi.yml Raw ↑

Other APIs Confluent publishes across the network.

Confluent
Confluent Managed MCP Servers
Confluent ACLs API
Confluent API Keys API
Confluent Clusters API
Confluent Consumer Groups API
Confluent Environments API
Confluent Partitions API
Confluent Service Accounts API
Confluent Topics API
Confluent Access Points (networking/v1) API
Confluent ACL (v3) API
Where this information came from

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.