For the complete documentation index, see llms.txt. This page is also available as Markdown.

Notification Box

Provides a feature that sends notification messages to users after tasks are completed in other modules, and allows those notifications to be viewed on My Page.


Key Features

  • Send Notification Message

    • Sends a notification message to the customer after a specific task has been processed and completed.

  • My Page Notification Box

    • Provides a notification box area within My Page where customers can view notification messages for completed tasks.

  • View Notification Message Details

    • Selecting a notification message in the notification box allows the customer to view its detailed information.

  • Navigate to Notification-Related Page

    • Selecting a notification message in the notification box navigates to the registered URL for the related task.

Process Definition

1

Get Notification Box

Retrieves the notification box when the user enters the notification box page on My Page. If the member notification type code parameter is provided, only the notification box list corresponding to that code is retrieved. If the member notification type code is not provided, retrieves the member's full notification box list in latest-first order.

2

Register Notification Box Entry

Registers a notification box entry when another module requests registration after processing a specific task. If the requested notification box template includes button information, that button information is saved together with the entry. The saved notification box entry can be viewed under My Page > Notification Box.

API Function List

API
Description
Server
Method

Get Notification Box

Retrieves the member's notification box list.

Member

GET

Register Notification Box Entry

Provides notification box registration processing when another module calls the notification box registration API after completing a task.

Member

POST

Definition of Terms

Term
Description

Notification Box

A term referring to a space for storing and displaying important information, messages, and notifications for the user.

Other Notes

  • When retrieving the notification box, if the member notification type code (ME051) is provided as a parameter, only the notification box list corresponding to that member notification type code (ME051) is retrieved.

  • Notification message registration calls the API in the order: other module API -> x2bee-api-common -> x2bee-api-member.

  • Notification box entries older than 7 days are automatically deleted by a batch job.