This page provides a reference for New Relic notification actions available in the Workflow Automation actions catalog. These actions enable you to send notifications through New Relic.
Prerequisites
Before using New Relic actions in workflow automation, ensure you have the following:
- A New Relic account with appropriate permissions.
- A New Relic license key (if sending data to a different account).
- The necessary permissions for the specific New Relic services you plan to use.
See License Key for information on how to create and manage your New Relic Account License Key.
Send message
Sends messages or emails to New Relic destinations. You must first create the appropriate destination in New Relic, then use its ID in this action. The action identifier is newrelic.notification.send.
The following table describes all available input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
type | String | Required. The destination type. |
|
destinationId | String | Required. DestinationId associated with the New Relic destination. See NerdGraph tutorial: Alerts destinations to configure a destination and retrieve its ID, and Destinations for more information. |
|
parameters | Map | Required. Fields required to send the notification to the chosen destination type. For Slack: |
or
|
attachments | List | Optional. A list of optional attachments. This action doesn't support attachments when | |
attachment.type | Enum | Required. The content type of the attachment: | |
attachment.query | String | Optional. For |
|
attachment.accountIds | List | Optional. For |
|
attachment.format | Enum | Optional. For |
|
attachment.content | String | Optional. For |
|
attachment.filename | String | Optional. A filename for the attachment. If omitted, a name is generated automatically. |
|
attachment.dashboardGuid | String | Required (for |
|
attachment.dashboardParams | Object | Optional (for | |
attachment.dashboardParams.format | Enum | Optional. File format of the snapshot. |
|
attachment.dashboardParams.display | Object | Optional. Dimensions of the snapshot image. | |
attachment.dashboardParams.display.width | Integer | Optional. Width in pixels. Min: |
|
attachment.dashboardParams.display.height | Integer | Optional. Height in pixels. Min: |
|
attachment.dashboardParams.variables | List | Optional. Template variable overrides. Each entry requires | |
attachment.dashboardParams.timeWindow | Object | Optional. Time window for the snapshot. Omit entirely to use the dashboard's saved time window. Provide either | |
attachment.dashboardParams.timeWindow.duration | Integer | Optional. Relative time window in milliseconds. |
|
attachment.dashboardParams.timeWindow.beginTime | Integer | Optional. Absolute start time in epoch milliseconds. Use with |
|
attachment.dashboardParams.timeWindow.endTime | Integer | Optional. Absolute end time in epoch milliseconds. Use with |
|
attachment.dashboardParams.entityFilter | String | Optional. Filters dashboard data by entity. Provide the filter expression without the |
|
selectors | List | Optional. Selectors to extract specific fields from the output. |
|
The following table describes all output fields returned by this action.
Output | Type | Example |
|---|---|---|
| String |
|
| String |
|
| List | |
Important
This action doesn't support attachments when sending to a Slack destination.
- Slack
name: slack_notification_workflowdescription: This is a test workflow to test slack notification send actionsteps: - name: SendMessageUsingSlackChannel type: action action: newrelic.notification.send version: 1 inputs: type: slack destinationId: ccd0d926-ed6f-4ddd-bc7d-b7eb9822908d parameters: text: Hi , Testing notifcation api using slack channel name channel: test-channel-workflowname: emailer-workflowdescription: send email using workflowsteps: - name: emailReport1 type: action action: newrelic.notification.email version: 1 inputs: type: email destinationId: "e7a5a004-424d-44db-a3df-266980a90242" parameters: subject: "workflow notification" message: "this is a message." attachments: - type: QUERY query: "SELECT * FROM Log" format: CSV filename: "log_count.csv" selectors: - name: success expression: '.success' - name: sessionId expression: '.response.sessionId' - name: attachments expression: '.response.attachments'Send a Microsoft Teams notification
Sends a message to a Microsoft Teams channel, integrated with destinations. The action identifier is newrelic.notification.sendMicrosoftTeams.
The following table describes all available input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
destinationId | String | Required. DestinationId associated with the New Relic destination. See New Relic integration for Microsoft Teams to configure a destination and retrieve its ID, and Destinations for more information. |
|
teamName | String | Required. Team name associated with the given destination ID. |
|
channelName | String | Required. Channel name to send the message to. |
|
message | String | Required. Text message to send. |
|
selectors | List | Optional. Selectors to extract specific fields from the output. |
|
The following table describes all output fields returned by this action.
Output | Type | Example |
|---|---|---|
| Boolean |
|
| String |
|
| String |
|
Workflow example |
|---|
|
Send an email
Sends an email to New Relic email destinations, with or without attachments. The action identifier is newrelic.notification.sendEmail.
The following table describes all available input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
destinationId | String | Required. DestinationId associated with the New Relic destination. See NerdGraph tutorial: Alerts destinations to configure a destination and retrieve its ID, and Destinations for more information. |
|
subject | String | Required. Subject of the email. |
|
message | String | Required. Message to send in the email. |
|
attachments | List | Optional. A list of optional attachments. | |
attachment.type | Enum | Required. The content type of the attachment: | |
attachment.query | String | Optional. For |
|
attachment.accountIds | List | Optional. For |
|
attachment.format | Enum | Optional. For |
|
attachment.content | String | Optional. For |
|
attachment.filename | String | Optional. A filename for the attachment. If omitted, a name is generated automatically. |
|
attachment.dashboardGuid | String | Required (for |
|
attachment.dashboardParams | Object | Optional (for | |
attachment.dashboardParams.format | Enum | Optional. File format of the snapshot. |
|
attachment.dashboardParams.display | Object | Optional. Dimensions of the snapshot image. | |
attachment.dashboardParams.display.width | Integer | Optional. Width in pixels. Min: |
|
attachment.dashboardParams.display.height | Integer | Optional. Height in pixels. Min: |
|
attachment.dashboardParams.variables | List | Optional. Template variable overrides. Each entry requires | |
attachment.dashboardParams.timeWindow | Object | Optional. Time window for the snapshot. Omit entirely to use the dashboard's saved time window. Provide either | |
attachment.dashboardParams.timeWindow.duration | Integer | Optional. Relative time window in milliseconds. |
|
attachment.dashboardParams.timeWindow.beginTime | Integer | Optional. Absolute start time in epoch milliseconds. Use with |
|
attachment.dashboardParams.timeWindow.endTime | Integer | Optional. Absolute end time in epoch milliseconds. Use with |
|
attachment.dashboardParams.entityFilter | String | Optional. Filters dashboard data by entity. Provide the filter expression without the |
|
selectors | List | Optional. Selectors to extract specific fields from the output. |
|
The following table describes all output fields returned by this action.
Output | Type | Example |
|---|---|---|
| Boolean |
|
| String |
|
| String |
|
| List | |
Workflow example: QUERY attachment |
|---|
|
Workflow example: Dashboard snapshot attachment |
|---|
|
Send a Slack message
Sends a Slack message to a channel, integrated with destinations. The action identifier is newrelic.notification.sendSlack.
The following table describes all available input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
destinationId | String | Required. DestinationId associated with the New Relic destination. See NerdGraph tutorial: Alerts destinations to configure a destination and retrieve its ID, and Destinations for more information. |
|
text | String | Optional. Text message to send. Provide either |
|
blocks | List | Optional. JSON array of Slack Block Kit elements. See Supported block types. Provide either |
|
channel | String | Required. Channel name to send the message to. |
|
threadTs | String | Optional. Timestamp of the parent message, used to post a reply in a thread. |
|
selectors | List | Optional. Selectors to extract specific fields from the output. |
|
Supported block types
The sendSlack action supports only two block types and rejects any others during validation.
Block type | Description | Allowed keys | Example |
|---|---|---|---|
| This is the only block type that renders text. The |
|
|
| Renders a visual horizontal line. |
|
|
For more information, see the Slack Block Kit reference and the Slack Block Kit Builder.
The following table describes all output fields returned by this action.
Output | Type | Example |
|---|---|---|
| Boolean |
|
| String |
|
| String |
|
Workflow example with a text message |
|---|
|
Workflow example using blocks |
|---|
|
Run a workflow
Runs a workflow through the NerdGraph API. The action identifier is newrelic.workflowAutomation.startWorkflowRun.
The following table describes all available input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
definitionName | String | Required. Name of the workflow definition. | |
definitionScopeType | String | Optional. Scope type of the workflow definition. Must be either | |
definitionVersion | Int | Optional. Version of the workflow definition. | |
idempotencyKey | String | Optional. A valid UUID to ensure idempotency of the request. The server validates this format and rejects non-UUID values. |
|
workflowInputs | List | Optional. Key-value pairs to pass as inputs to the workflow definition. | |
runScopeType | String | Required. Scope type for the run. Must be |
|
runScopeId | String | Required. Account ID for the run scope. |
|
selectors | List | Optional. Selectors to extract specific fields from the output. |
Example
steps: - name: startHealthyHeartbeat type: action action: newrelic.workflowAutomation.startWorkflowRun version: 1 inputs: definitionName: "heartbeat_newrelicIngestSendEvents_10062025" definitionVersion: 1 scopeType: "ACCOUNT" definitionScopeType: "d34568b7-ee0b-4191-b663-7b2925b0de5b" workflowInputs: - key: "cellName" value: "stg-joint-effort" runScopeType: "ACCOUNT" runScopeId: "11544325"The following table describes all output fields returned by this action.
Output | Type | Example |
|---|---|---|
runId | Unique identifier for the workflow run. | |
success | Boolean |
|
errorMessage | String | Error message if the run failed to start. |
Workflow example |
|---|
|
Create a signal URL
Generates a URL to send to a user via Microsoft Teams, Slack, or email so they can send a signal to a running workflow. This action powers the human-in-the-loop pattern, where a workflow pauses at a wait step until a person clicks the URL to approve, deny, or otherwise route the run.
Important
This action provides no benefit on its own. Always use this action with:
A notification action (
newrelic.notification.*orslack.chat.postMessage) that delivers the generated URL to a person.A wait step that defines at least one signal for the workflow run to wait on.
The
waitStepNameyou provide as input must match the name of a valid wait step in the same workflow definition, and that wait step must contain at least one signal. Otherwise the workflow definition fails validation when you create it.
The following table describes all available input fields for this action.
Input | Type | Description | Example |
|---|---|---|---|
| String | Required. The name of the wait step in the workflow that contains the signals the run waits for. Must match a valid wait step name in the workflow definition, and that step must contain at least one signal. Maximum length: 100 characters. |
|
| List | Optional. Selectors to extract specific fields from the output. |
|
The following table describes all output fields returned by this action.
Output | Type | Example |
|---|---|---|
| String |
|
| Boolean |
|
| String |
|
Workflow example |
|---|
|