plantera-api
    Plantera API V2
    • Plantera API
    • Plant Analyzer
    • Plantera API V2
    • Auth
      • Forgot Password
        POST
      • Verify OTP
        POST
      • Register
        POST
      • Logout
        POST
      • Reset Password
        POST
      • Login
        POST
      • Refresh Token
        POST
    • Plants
      • Get Plant By ID
        GET
      • List Plants
        GET
      • Diagnose Plant
        POST
      • Classify Plant
        POST
    • Diseases
      • List Diseases
        GET
      • Get Disease
        GET
    • Diagnostics
      • Get Diagnostic Record
        GET
      • List Diagnostic Records
        GET
      • Submit Diagnostic Image
        POST
    • My Plants
      • Care
        • Fertilize Plant
        • Water Plant
        • Mark care task as complete
        • Get Upcoming Care Tasks
        • Get Care Calendar
        • Get care habit logs
        • Get care events
      • Identification
        • Identify plant from image
        • Confirm plant identification
      • Diagnosis
        • Diagnose MyPlant
        • Get diagnosis history
      • Settings
        • Update plant image
        • Remove Plant from Collection
      • List My Plants
        GET
      • Add Plant to Collection
        POST
    • Profile
      • Update Profile
        PATCH
      • Get Profile
        GET
      • Change Password
        PATCH
      • Update Notification Preferences
        PATCH
      • Get Notification Preferences
        GET
      • Remove Push Token
        DELETE
      • Save Push Token
        POST
    • Notifications
      • List Notifications
      • Mark Notification Read
    • Posts
      • Comments
        • Create Comment
        • List Comments
        • Delete Comment
      • Likes
        • Toggle Like
        • Get Likes
      • List Posts
      • Create Post
      • Get Post
      • Update Post
      • Delete Post
    • Admin
      • Article
        • Create Article
        • List Articles
        • Get Article
        • Update Article
        • Delete Article
    • Real-time Notifications
    • Schemas
      • Errors
        • ErrorResponse
        • InternalServerError
        • RateLimitError
        • NotFoundError
        • ForbiddenError
        • MethodNotAllowedError
        • BadRequestError
        • UnsupportedMediaTypeError
        • UnauthorizedError
      • Envelopes
        • GlobalErrorCode
        • Success
        • ConflictError
        • ValidationError
      • Models
        • User
          • Model
            • User
          • Props
            • FirstName
            • LastName
            • UserName
            • Email
            • Password
        • PaginationMeta
      • Auth
        • dto
          • LogoutResponse
          • ForgotPasswordResponse
          • ResetPasswordResponse
          • LoginRequest
          • RefreshTokenRequest
          • ForgotPasswordRequest
          • VerifyOtpRequest
          • ResetPasswordRequest
          • RegisterRequest
          • AuthResponse
          • RefreshTokenResponse
          • VerifyOtpResponse
        • Errors
          • LoginValidationError
          • ForgotPasswordValidationError
          • RefreshTokenValidationError
          • ResetPasswordValidationError
          • VerifyOtpValidationError
          • LoginUnauthorizedError
          • VerifyOtpBadRequestError
          • RefreshUnauthorizedError
          • ResetPasswordBadRequestError
          • ResetPasswordNotFoundError
          • RegisterValidationError
          • RegisterConflictEmailError
          • RegisterConflictUsernameError
          • LoginConflictError
          • AuthErrorCode
      • Plants
        • Plant
        • PlantNotFoundError
        • PlantResponse
        • PlantMissingImageError
        • PlantInvalidFileTypeError
        • PlantClassifyResponse
        • PlantListQuery
        • PlantListResponse
        • PlantDiagnoseResponse
        • PlantFileSizeExceededError
        • PlantEmptyImageFileError
      • Diseases
        • Disease
        • DiseaseListQuery
        • DiseaseListResponse
        • DiseaseResponse
        • DiseaseNotFoundError
      • Diagnostics
        • DiagnosticNotFoundError
        • DiagnosticRecord
        • DiagnosticListResponse
        • DiagnosticListQueryDto
        • DiagnosticResponse
      • MyPlants
        • MyPlant
        • MyPlantListQueryDto
        • CalendarCareQueryDto
        • UpdateScheduleDto
        • MyPlantResponse
        • MyPlantsListResponse
        • UpcomingCareResponse
        • MyPlantNotFoundError
        • MyPlantAlreadyExistsError
        • AddToMyPlantsResponse
        • DeleteMyPlantResponse
        • CareLog
        • CareLogListResponse
        • CareEvent
        • CareEventListResponse
        • IdentifyPlantResponse
        • IdentifyPlantSuggestionsResponse
        • ConfirmIdentifyResponse
        • AddToMyPlantsDto
        • CalendarCareResponse
        • AddToMyPlantsValidationError
      • Profile
        • ChangePasswordRequestDto
        • UpdateProfileRequestDto
        • EmailTakenError
        • PasswordIncorrectError
        • PasswordFailedError
        • UserNotFoundError
        • UpdateProfileResponse
        • UpdateNotificationPreferencesResponse
        • GetNotificationPreferencesResponse
        • SendEmailOtpDto
        • VerifyEmailOtpDto
        • EmailOtpSentResponse
        • EmailVerifiedResponse
        • RemovePushTokenResponse
        • SavePushTokenResponse
        • Profile
        • GetProfileResponse
        • SendEmailOtpValidationError
        • NotificationPreferences
        • SavePushTokenDto
        • UpdateNotificationPreferencesRequestDto
        • ChangePasswordResponse
        • PushTokenInvalidError
        • ProfileUpdateFailedError
      • Notifications
        • Notification
        • NotificationListResponse
        • NotificationNotFoundError
        • MarkNotificationReadResponse
      • Articles
        • Article
        • CreateArticleDto
        • UpdateArticleDto
        • ArticleListResponse
        • ArticleResponse
        • ArticleNotFoundError
        • ArticleForbiddenError
        • ArticleValidationError
        • ArticleDeleteResponse
      • Community
        • CommunityPost
        • CreateCommunityDto
        • UpdateCommunityDto
        • CommunityListResponse
        • CommunityResponse
        • CommunityNotFoundError
        • CommunityForbiddenError
        • CommunityValidationError
        • Comment
        • CommentResponse
        • CommentListResponse
        • LikeResponse
        • CreateCommentDto
        • CommunityDeleteResponse
      • Default Folder
        • User1
    Github

    Real-time Notifications

    Maintainer:Not configured

    Connection#

    Socket.IO server for real-time push notifications.
    Server address: ws://localhost:8000
    Handshake path: /socket.io (default)

    Authentication#

    Provide a JWT token (from POST /api/v1/auth/login) in the handshake auth object.

    Events#

    notification (Server → Client)#

    Payload:
    type (string): comment, like, watering_reminder, fertilizing_reminder
    title (string): Notification title
    body (string): Notification body
    data (object|null): Additional payload
    plantId (number|null): Related plant ID

    Usage#

    Request

    None
    Modified at 2026-07-02 18:13:34
    Previous
    Delete Article
    Next
    ErrorResponse
    Built with