Skip to main content

Send notification

The BPMN block to send system and email notifications to users during business process

Implementation type

Connector

Connector ID

http-connector

Connector inputs​

headers

Map

method

POST

payload script example

JSON.stringify({
    {
    execution_id: "UUID",
    stage: "string",
    is_completed:bool
    payload: {
        to: [
            "GROUP_ID",
            "USER_ID",
      JSON.parse(execution.getVariable("users"))["expert"],
        ],
        message: "MESSAGE",
        need:{
            mass_approve:bool,
            response:bool,
            assign:bool
        },
        ui:{
            caption:"string",
            assign:"string",            
            buttons: {
                approve:"Approved",
                reject:"Rejected"
            }
        }
    }
});


where

  • execution_id - is the id of runtime process, define execution context in Camunda;
  • stage - is the name of process step to display in the monitoring table in the Accton admin panel
  • is_completed - is the flag to define the finish step of process for the monitoring table in the Accton admin panel
  • payload - is the detailed information about things need to get done:
    • notification - information about notification message:
      • to - is an array of user or group ids, who need to receive notification; can be provided as a role. If a group id is provided, all users in the group will receive notification;
    • message - is the text message will be show in notification in Accton;
      • need - is an array of options for notification in Accton:
        • mass_approve - is boolean value. If true provided all users need to approve to push process to next step; else - one of response enough to proceed (is_approved variable);
        • response - is boolean value. If true provided in notification on the object view page in Accton user will see input field, which will be sent to Camunda as expertise_text variable;
        • assign - is boolean value. If true provided in notification on the object view page user will see the select field to choose one user only. Selected user will be assigned to hidden Assignee role, and can be used in the business process;
      • ui - is an array of options for buttons and fields in the notificaion window in Accton
        • caption - is the title for notificaito window;
        • assign - is the title for the Assignee field in the notification window, can't be empty if the need_assign is true;
        • buttons - is an array of display buttons in the notification window; the key can be to approve or reject. Value is button text visible to users in Accton

url script

execution.getVariable('domain') + '/api/bp/notify';