Send

The Send option is responsible to manage all the params that it can be set to a notification. It checks in which platforms the message can be send and to which users, also it stores the notification to the right queue/s and sends a positive response to the agent if it can be send. Then, the Workers does the rest of the work.

Routes

/send

📘

Sends a notification to the target given its params.

ParamsTypeRequired?Description
messagestringtrueNotification message
themestringtrueTheme name refering which type of notification is
user_idintfalseUser identification if the notification is unicast
channelintfalseChannel identification if the notification is multicast
subjectstringfalseSubject customization instead of using the default value
delayintfalse (max value 3600 seconds)Delay time in seconds of the notification
time_to_liveintfalse (default 86400 seconds)Time to live of a notification. Used to prevent send outdated notifications if the workers are stopped and not executed again.

Response

{
    "result": true
}

Back to Index