BREAGEN Logo
Notification Center

Notification Center

The Notification Center provides a high-performance framework for building and managing APIs with FastAPI, leveraging its speed and simplicity for optimal performance. This service includes comprehensive notification operations, enabling seamless addition and retrieval of notifications to keep users informed in real-time. Additionally, it supports robust WebSocket operations, including sending messages, broadcasting to multiple clients, and managing connections, ensuring efficient real-time communication and interaction. Designed for scalability and efficiency, the Notification Center is ideal for organizations seeking to implement responsive and interactive API-driven applications.

Notification Operations

Notification Operations provide a comprehensive suite of APIs for managing notifications, allowing for seamless addition and retrieval of alerts to keep users informed and up-to-date in real-time.

Notification Operations - Add Notification POST /v1/notification/create_notification

Resource URL/v1/notification/create_notification
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

curl -X 'POST' \
'https://notifications.braegen.ai/v1/notification/create_notification' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '[
    {
    "subject": "Email verification",
    "body": "Email verification code is -uQ&8h",
    "links": {},
    "meta_data": {
        "verification_code": "-uQ&8h"
    },
    "notification_type": "email-verification",
    "channel": [
    "email"
    ],
    "receivers": [
    "[email protected]"
    ],
    "session_ids": [
    "2373"
    ]
    }
]'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "message": "Notification enqueued successfully"
}

HTTP Responses

HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
403Invalid Input
404invalid or not founc type

Notification Operations - Get Notification List GET /v1/notification/notification_list

Resource URL/v1/notification/notification_list
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Example Request

curl -X 'GET' \
'https://notifications.braegen.ai/v1/notification/notification_list?email=analyst%40datafab.ai' \
-H 'accept: application/json'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

[
  {
    "id": 2371,
    "subject": "Email verification",
    "body": "Email verification code is -uQ&8i",
    "links": {},
    "meta_data": {
      "verification_code": "-uQ&8i"
    },
    "receivers": "[\"[email protected]\"]",
    "send_datetime": "2024-06-04T05:19:28",
    "notification_type": "email-verification",
    "channel": "email"
  },
  {
    "id": 2406,
    "subject": "Email verification",
    "body": "Email verification code is 7kSWJ8",
    "links": {},
    "meta_data": {
      "verification_code": "7kSWJ8"
    },
    "receivers": "[\"[email protected]\"]",
    "send_datetime": "2024-06-10T09:16:04",
    "notification_type": "email-verification",
    "channel": "email"
  }
]

HTTP Responses

HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
403Invalid Input
404invalid or not founc type

On this page