# Backstage Notifications API

**Canonical:** https://apis.io/apis/backstage/backstage-notifications-api/  
**Provider:** Backstage — https://apis.io/providers/backstage/  
**Base URL:** https://{backstageHost}/api/notifications  
**Documentation:** https://backstage.io/docs/notifications/

Backstage Notifications API is one of 15 APIs that [Backstage](https://apis.io/providers/backstage/) publishes on the [APIs.io](https://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.

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.

## Operations (12)

| Method | Path | Summary |
|---|---|---|
| GET | `/` | — |
| POST | `/` | — |
| GET | `/notifications` | — |
| POST | `/notifications` | — |
| POST | `/update` | — |
| POST | `/notifications/update` | — |
| GET | `/status` | — |
| GET | `/settings` | — |
| POST | `/settings` | — |
| GET | `/topics` | — |
| GET | `/{id}` | — |
| GET | `/notifications/{id}` | — |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/backstage/refs/heads/main/openapi/backstage-notifications-backend-openapi.yaml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/backstage/refs/heads/main/overlays/backstage-notifications-backend-overlay.yaml
- **Documentation** — https://backstage.io/docs/notifications/

## Other Backstage APIs (12)

- [Backstage Events System](https://apis.io/apis/backstage/events-system/)
- [Backstage Actions API](https://apis.io/apis/backstage/backstage-actions-api/)
- [Backstage Authentication API](https://apis.io/apis/backstage/backstage-authentication-api/)
- [Backstage Authorization API](https://apis.io/apis/backstage/backstage-authorization-api/)
- [Backstage Documentation API](https://apis.io/apis/backstage/backstage-documentation-api/)
- [Backstage Entities API](https://apis.io/apis/backstage/backstage-entities-api/)
- [Backstage Locations API](https://apis.io/apis/backstage/backstage-locations-api/)
- [Backstage Metadata API](https://apis.io/apis/backstage/backstage-metadata-api/)
- [Backstage Search API](https://apis.io/apis/backstage/backstage-search-api/)
- [Backstage Sync API](https://apis.io/apis/backstage/backstage-sync-api/)
- [Backstage Tasks API](https://apis.io/apis/backstage/backstage-tasks-api/)
- [Backstage Templates API](https://apis.io/apis/backstage/backstage-templates-api/)

## Tags

Notifications, Developer Portal

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/backstage/backstage-notifications-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/backstage/.