Saltar al contenido
NimbusNexus

Notifications

Notification preferences control which events trigger an email to which contact, and which trigger a webhook delivery instead (or in addition). Categories include billing alerts, security events, quota warnings, scheduled-maintenance announcements, and feature releases.

The defaults are sane — billing and security always go to the billing/security contact regardless of preferences. The configurable categories are operational ones: maintenance windows, quota thresholds, beta-feature announcements, etc.

For larger teams the typical pattern is to route operational notifications via webhooks into your incident-management system (PagerDuty, Opsgenie) rather than email to a single contact. The webhook route here uses the same delivery semantics as the webhooks doc.

What's next

  • Webhooks — the delivery channel for non-email routing.
  • Account overview — where the billing and security contacts live.

Reference

POST/api/v1/notifications/

Create Notification

Create a new in-app notification addressed to the calling user in the current scope.

Request body

JSON body required.

Responses

  • 201Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 422Validation error
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/notifications/

PATCH/api/v1/notifications/

Update Notification

Update a single notification (for example to mark it as read) and return the updated record.

Request body

JSON body required.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 404Not Found
  • 422Validation error
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/notifications/

DELETE/api/v1/notifications/

Delete Notification

Delete a single notification by ID.

Request body

JSON body required.

Responses

  • 204Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 404Not Found
  • 422Validation error
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/notifications/

PATCH/api/v1/notifications/bulk

Update Notifications Bulk

Update many notifications in a single transaction; reports any IDs that were not found.

Request body

JSON body required.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 409Conflict
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/notifications/bulk

DELETE/api/v1/notifications/bulk

Delete Notification Bulk

Delete many notifications in a single transaction; reports any IDs that were not found.

Request body

JSON body required.

Responses

  • 204Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 422Validation error
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/notifications/bulk

GET/api/v1/notifications/list

Get Notifications List

List the calling user's notifications with filtering by delivery status, metadata and pagination.

Parameters

NameInRequiredDescription
idqueryno—
statusesqueryno—
notification_typesqueryno—
workspace_idqueryno—
meta_data_keyqueryno—
meta_data_valuequeryno—
offsetqueryno—
limitqueryno—
sort_byqueryno—
sort_descqueryno—
provide_workspace_idqueryno—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 422Validation error
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/notifications/list

GET/api/v1/notifications/websocket-info

WebSocket connection guide

## WebSocket Endpoint `wss://<host>/api/v1/ws` This endpoint establishes a persistent WebSocket connection used to receive real-time notifications. --- ## Authentication Authentication is required. JWT token must be provided in **HTTP headers** during the WebSocket handshake:

Responses

  • 200Successful Response
  • 401Unauthorized
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/notifications/websocket-info

Need to make a real call? Try these endpoints in the live Swagger UI →

Edit this page on GitHub