e18f4522d5
* Move assets to 5.7 location * Add 5.7 SVGs * add cache data dir * update QUEUE_DRIVER -> QUEUE_CONNECTION * Update trusted proxy config * update composer.json * 5.5 command loading * @php and @endphp can't be inline * Laravel 5.6 logging, Nice! * Update blade directives * improved redirects * remove unneeded service providers * Improved debugbar loading * no need to emulate renderable exceptions anymore * merge updated 5.7 files (WIP) * Enable CSRF * database_path() call causes issue in init.php * fix old testcase name * generic phpunit 7 fixes * add missed file_get_contents Keep migrations table content * fix duplicate key * Drop old php versions from travis-ci * remove hhvm * fix code climate message * remove use of deprecated function assertInternalType * Disable CSRF, we'll enable it separately. All forms need to be updated to work. * Update document references
1.5 KiB
source: Alerting/Creating-Transport.md path: blob/master/doc/
Creating a new Transport.
File location
All transports are located in LibreNMS\Alert\Transport and the files are named after the Transport name. I.e
Discord.php for Discord.
Transport structure.
The following functions are required for a new transport to pass the unit tests:
deliverAlert() - This is function called within alerts to invoke the transport. Here you should do any post processing
of the transport config to get it ready for use.
contact$Transport() - This is named after the transport so for Discord it would be contactDiscord(). This is what
actually interacts with the 3rd party API, invokes the mail command or whatever you want your alert to do.
configTemplate() - This is used to define the form that will accept the transport config in the webui and then what
data should be validated and how. Validation is done using Laravel validation
The following function is not required for new Transports and is for legacy reasons only. deliverAlertOld().
Documentation
Please don't forget to update the Transport file to include details of your new transport.
A table should be provided to indicate the form values that we ask for and examples. I.e:
**Example:**
Config | Example
------ | -------
Discord URL | https://discordapp.com/api/webhooks/4515489001665127664/82-sf4385ysuhfn34u2fhfsdePGLrg8K7cP9wl553Fg6OlZuuxJGaa1d54fe
Options | username=myname