Skip to main content

sendNoteToIncident

A Workflow Engine function that sends a request to the corresponding outbound integration workflow to post a message to the incident for the named service. By default, the function uses the contents of workflowContext noteText key. You can override this behavior using the either of the optional noteText or templateName arguments.

This function is available as a feature of the Add-ons v2.2 download and later.

This function is available for alert and Situation workflows.

Back to Workflow Engine Functions Reference.

Arguments

Workflow Engine function sendNoteToIncident takes the following arguments:

Name

Required

Type

Description

serviceName

yes

string

The name of the incident integration; has the value alertops.

instanceName

no

string

An instance name for integrations supporting multiple instances; defaults to the first instance.

templateName

no

string

An integration template which populates the messages. The function uses the noteText key when there is no templateName or noteText argument.

noteText

no

string

Text which posts when noteText is included and templateName is omitted.

arguments

no

object

A JavaScript object that passes any additional arguments as context to the workflow and adds them to the existing workflow context.

In this section: