DirectNotificationValve

Valve used to send notifications over SMS and/or SMTP.

Properties

Name Description Default value Mandatory Supports property expansion
recipient_param_name Parameter containing recipient mobile number/mail address. Yes Yes
static_recipients List of static recipients. Separated by comma (,). No No
use_sms If the notification should be sent with SMS. false Yes No
sms_message Message to be sent to SMS recipients. No No
sms_wash_recipient_number If the mobile number should be washed (removes non numerical characters). true No No
sms_recipient_prefix Removes leading '0' and adds a prefix to the recipient numbers. No No
force_prefix Always add the prefix. false No No
sms_remove_leading_plus Removes leading '+' of the recipient numbers. false No No
use_smtp If the notification should be sent with SMTP. false Yes No
smtp_message Message to be sent to SMTP recipients. No No
smtp_removal_prefixes Removes leading prefix of SMTP recipient numbers. smtp:,SMTP:,sip: No No

Example Configuration

{
    "name": "DirectNotificationValve",
    "config": { 
        "recipient_param_name":"{{item.mobile}}",
        "static_recipients": "jdoe@company.org",
        "use_sms":"true",
        "use_smtp":"true",
        "sms_message":"Notification from auth server",
        "smtp_message":"Notification from auth server",
        "sms_wash_recipient_number":"true",
        "sms_recipient_prefix":"+46",
        "force_prefix":"true"
     }
}

Requirements

Item set must have at least one entry.

Used with the module "com.phenixidentity~phenix-external-event".