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

Backstage Notifications API

The Backstage Notifications API delivers user- and group-addressed notifications inside a Backstage portal. Plugins create notifications with a topic, severity and link; users list, read, mark and save them, manage per-topic delivery settings, and query unread status. It is served by @backstage/plugin-notifications-backend on the operator's own Backstage backend at /api/notifications, and the OpenAPI below is published first-party in the Backstage monorepo.

Backstage Notifications API is one of 15 APIs that Backstage publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Notifications and Developer Portal. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 9 paths, and defines 17 schemas. It is described by OpenAPI 3.1.0, at version 1.

Requests are made against a single base URL, /.

12 operations 9 paths 17 schemas 7 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1
Base URL
https://{backstageHost}/api/notifications
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Backstage Notifications API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (JWT).

Paths & Operations 12

Across 9 paths, the API surfaces 12 operations — 7 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Operations 12
GET
/deprecated
Deprecated alias for GET /notifications.
ListNotificationsLegacy 9 params → 200default
POST
/deprecated
Deprecated alias for POST /notifications.
CreateNotificationsLegacy body → 200default
GET
/notifications
List notifications for the current user.
ListNotifications 9 params → 200default
POST
/notifications
Send a notification to one or more recipients (service credentials required).
CreateNotifications body → 200default
POST
/updatedeprecated
Deprecated alias for POST /notifications/update.
UpdateNotificationsLegacy body → 200default
POST
/notifications/update
Mark notifications as read/unread or saved/unsaved.
UpdateNotifications body → 200default
GET
/status
Get the unread/read counts for the current user.
GetStatus → 200default
GET
/settings
Get the current user's notification settings, merged with defaults.
GetSettings → 200default
POST
/settings
Update the current user's notification settings.
UpdateSettings body → 200default
GET
/topics
List notification topics that the user has received notifications on.
GetTopics 5 params → 200default
GET
/{id}deprecated
Deprecated alias for GET /notifications/{id}.
GetNotificationLegacy 1 param → 200default
GET
/notifications/{id}
Get a single notification by id for the current user.
GetNotification 1 param → 200default

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Notification (8 properties), NotificationPayload (8 properties), NotificationResponsePayload (8 properties), Error (3 properties). Each schema is shown below with its type and property counts.

NotificationSeverity
string
NotificationPayload
object
8 properties 1 required
NotificationResponsePayload
object
Response variant of NotificationPayload. Optional string fields may be returned as null when unset.
8 properties 1 required
Notification
object
8 properties 5 required
NotificationStatus
object
2 properties 2 required
TopicSetting
object
2 properties 2 required
OriginSetting
object
3 properties 2 required
ChannelSetting
object
3 properties 2 required
NotificationSettings
object
1 property 1 required
EntityRef
A single entity ref, or a list of entity refs.
OrderField
One or more "field,direction" pairs, given as a single string or an array of strings.
NotificationRecipients
NotificationSendOptions
object
2 properties 2 required
UpdateNotificationsRequest
object
3 properties 1 required
ListNotificationsResponse
object
2 properties 2 required
GetTopicsResponse
object
1 property 1 required
Error
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

backstage-notifications-backend-openapi.yaml Raw ↑

Other APIs Backstage publishes across the network.

Backstage Events System
Backstage Actions API
Backstage Authentication API
Backstage Authorization API
Backstage Documentation API
Backstage Entities API
Backstage Locations API
Backstage Metadata API
Backstage Search API
Backstage Sync API
Backstage Tasks API
Backstage Templates API
Where this information came from

This is an independent, third-party profile of Backstage Notifications 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.