overview
<p>Issues a notification</p>
functiondefinition
<ac:structured-macro ac:name="code"><ac:parameter ac:name="language">cpp</ac:parameter><ac:plain-text-body><![CDATA[void WG_API NotificationReport(
LPCWSTR strIncident,
LPCWSTR strMessage,
LPCWSTR strPlan
);]]></ac:plain-text-body></ac:structured-macro>
parameters
<p><ac:structured-macro ac:name="vardef"><ac:parameter ac:name="Name">strIncident</ac:parameter><ac:parameter ac:name="Type">LPCWSTR</ac:parameter><ac:parameter ac:name="Style">Parameter</ac:parameter><ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter><ac:rich-text-body><p>The name of the notification incident you are reporting. e.g. "Failed to open database"</p></ac:rich-text-body></ac:structured-macro><ac:structured-macro ac:name="vardef"><ac:parameter ac:name="Name">strDescription</ac:parameter><ac:parameter ac:name="Type">LPCWSTR</ac:parameter><ac:parameter ac:name="Style">Parameter</ac:parameter><ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter><ac:rich-text-body><p>The message describing the event that will be displayed to the user</p></ac:rich-text-body></ac:structured-macro><ac:structured-macro ac:name="vardef"><ac:parameter ac:name="Name">strPlan</ac:parameter><ac:parameter ac:name="Type">LPCWSTR</ac:parameter><ac:parameter ac:name="Style">Parameter</ac:parameter><ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter><ac:rich-text-body><p>The name of the Notification Plan that you wish to invoke for this incident. Specify an empty string to use the "Default Plan"</p><div /></ac:rich-text-body></ac:structured-macro></p>
returnvalue
<p><ac:structured-macro ac:name="returnvalue"><ac:parameter ac:name="Type">void</ac:parameter><ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter><ac:rich-text-body><p>None</p></ac:rich-text-body></ac:structured-macro></p>
remarkscontent
<p><span>strIncident is both the name of the incident and an identifier for that instance of the notification. You must use this same identifier when closing the incident. By using a free form text field for an id, you can create and close incidents with ids and text based on contextual information. e.g. In policy a user could issue a notification event by specifying an incident name of:</span></p><p>"User {{User.AccountName}} is visiting a dubious website {{Request.URL}}"</p><p>And then close it with the same text without having to have remembered a new ID (UUID for instance) for each notified incident.</p>
examplescontent
None
seealsocontent
<p><ac:link><ri:page ri:content-title="NotificationAcknowledge" /></ac:link></p><p><ac:link><ri:page ri:content-title="NotificationClose" /></ac:link></p><p> </p>
Host
<p><ac:structured-macro ac:name="sdkhost"><ac:parameter ac:name="UI">false</ac:parameter></ac:structured-macro></p>