Back to MIR3 Integrations
Handler · Version 1

Mir3 Notification Send MIR3

Download GitHub

About

Using Mir3's SOAP API, an API call is made to send a new simple notification that is built using the inputted properties. The SOAP request body is created based on what type of notification method is chosen (Broadcast, First Response, Callout, or Bulletin Board) and is then sent to the Users associated with the usernames from the comma separated recipient list. The current options available just represent the minimal message that can be sent and much more can be done with the Mir3 API if the handler is updated/forked to use these extra capabilities. On a successful call, a Notification Report Id will be returned which can be used to check the notification status. This handler is currently using version 4.14 of the Mir3 API.

Configurations
Name Description Sample
username Mir3 username.
password Mir3 password. *********
enable_debug_logging Enable debug logging if the value is set to 'Yes'. No
Parameters
Name Description Sample
Title Notification title. Sample Notification
Description A notification description (that isn't visible to normal recipients). A description that recipients can't see
Notification Method What type of notification method to use. Broadcast
Message Message to send to the recipients. This is a sample broadcast notification
Recipient Usernames (CSV) A comma separated list of usernames that will recieve the notification. marymanager.acme,dondemo.acme
Response Options (CSV) A comma separated list of response options that will be sent to the recipients. Option 1,Option 2
Broadcast Duration (Mins) The duration of the Broadcast or Bulletin Board notification in minutes. 60
Callout Success Total For a callout, the amount of people that need to response to consider the notification a success.
Results
Name Description
Id Id of the newly created notification report
Changelog

Mir3 Notification Send V1 (2018-02-08)

  • Initial version. See README for details.
Download GitHub

On This Page

Looking for a workflow engine? Learn more about the Kinetic Data Enterprise Workflow Platform. Check it out
Return to Top