(408) 943-4100               V   Commercial Support


  1 minute read.

Last Modified 2021-02-04 11:38 EST
NamespaceNameAdmin OnlyLog SummaryGenerates EventVersion Added


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.

Input Arguments

  • 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.

Request Example Arguments

ARGUMENTS ONLY: See the basics of API requests for additional formatting information.

  "plugin" : "smtp-email"

Reply Example

  "result" : "Text sent"


This API call does not emit any middleware events.

Log Summary

This API call does not generate a detailed log summary item

See Also