alertplugins/test
1 minute read.
Last Modified 2021-02-04 11:38 EST| Namespace | Name | Admin Only | Log Summary | Generates Event | Version Added |
|---|---|---|---|---|---|
| alertplugins | test | no | no | no | 1.1 |
This will send a test alert to the current user. An individual plugin can be specified or the test can be sent through all configured plugins for the current user.
- Required Inputs:
- None ({})
- Optional Inputs:
- “plugin” (string) : Name of a single plugin to test. Will use all configured plugins if not specified.
- “settings” (JSON Object) : Custom settings object to use for the test instead of using the currently-saved configuration for the user.
ARGUMENTS ONLY: See the basics of API requests for additional formatting information.
{
"plugin" : "smtp-email"
}
{
"result" : "Text sent"
}
This API call does not emit any middleware events.
This API call does not generate a detailed log summary item