Notification Types API Documentation

This section provides detailed information about the different types of notifications that can be sent through our API.

Overview

Notifications are a crucial part of the communication system within our platform. They help keep users informed about important events, updates, and other relevant information. The Notification Types API allows developers to integrate and utilize various notification mechanisms into their applications.

Available Notification Types

Below is a list of the available notification types that can be sent using our API:

• Email Notifications: Send email alerts to users regarding various events.
• SMS Notifications: Deliver immediate messages to users' mobile devices.
• Push Notifications: Notify users through their mobile applications.
• In-App Notifications: Display messages directly within the user's application interface.

Email Notifications

Email notifications are ideal for delivering detailed information to users. They can include text, images, and links.

Example Usage:

POST /api/notifications/email
Content-Type: application/json

{
  "to": "user@example.com",
  "subject": "Welcome to Our Platform!",
  "body": "Thank you for joining us. Please check out our [features page](/Documentation/en/Explore/Developer/APIs/Features) for more information."
}

SMS Notifications

SMS notifications are great for time-sensitive alerts. They can be used to send reminders, updates, and other important messages.

Example Usage:

POST /api/notifications/sms
Content-Type: application/json

{
  "to": "+1234567890",
  "message": "Your order has been shipped. Thank you for shopping with us!"
}

Push Notifications

Push notifications are used to deliver real-time messages to users' mobile devices. They can be customized to match the user's preferences and device capabilities.

Example Usage:

POST /api/notifications/push
Content-Type: application/json

{
  "to": "user_token",
  "notification": {
    "title": "New Message",
    "body": "You have received a new message."
  }
}

In-App Notifications

In-app notifications provide immediate feedback and alerts to users within their application interface.

Example Usage:

POST /api/notifications/in-app
Content-Type: application/json

{
  "user_id": "12345",
  "message": "New update available. Please refresh the app to apply changes."
}

For more information on how to implement these notification types, please refer to our API Reference.

Notification Example