New Relic actions

preview

We're still working on this feature, but we'd love for you to try it out!

This feature is currently provided as part of a preview program pursuant to our pre-release policies.

This page provides a comprehensive reference for New Relic actions available in the workflow automation actions catalog. These actions enable you to integrate New Relic platform capabilities into your workflow definitions, including sending custom events and logs, executing NerdGraph queries, running NRQL queries, and sending notifications.

Prerequisites

Before using New Relic actions in workflow automation, ensure you have:

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.

Data ingest actions

Sends a custom events to New Relic

Input Field	Optionality	Type	Example
attributes	Optional	Map	`"{\"page\": \"1\", \"limit\": \"10\"}"`
events	Required	list	`"[{\"eventType\":\"XYZ\",\"attributes\":{\"foo\":\"bar\"}}, {\"eventType\":\"ABC\",\"value\":\"1234\",\"attributes\":{\"color\":\"red\"}}]`
licenseKey	Optional	string	`"{{ .secrets.secretName }}"`
selectors	Optional	list	`[{\"name\": \"success\", \"expression\": \".success\"}]`

Important

attributes: Common attributes which are part of all the events when provided. Merging for each event item when needed event item overrides common definition.
events: The list of event data. Note that events requires the use of an eventType field that represents the custom event type and the maximum events allowed per request is 100.
licenseKey: The New Relic Account License Key that specifies the target account where events are sent. If this value is not provided, a default license key is assumed based on the account executing the workflow.
selectors: The selectors to get only the specified parameters as output.

Output Field	Type	Example
success	Boolean	`true`
errorMessage	string	`"Error message if operation failed"`

Workflow example
name: heartbeat_newrelicIngestSendEvents workflowInputs: cellName: type: String steps: - name: runAction type: action action: newrelic.ingest.sendEvents version: 1 inputs: attributes: colour: red id: 1234 events: - eventType: HeartBeat test: "OK" attributes: foo: bar - eventType: HeartBeat1234 test: "OK1234" attributes: foo: bar - eventType: HeartBeat12345 test: "OK12345" attributes: foo: bar colour: yellow - eventType: HeartBeat12345678 test: "OK12345678" selectors: - name: success expression: ".success" Expected output: `{ "success": true }` Retrieve events: After successfully executing a workflow, you can retrieve the associated event by running a query under the account that executed the workflow: `SELECT * FROM HeartBeat`

Workflow example

name: heartbeat_newrelicIngestSendEvents

workflowInputs:
  cellName:
    type: String

steps:
  - name: runAction
    type: action
    action: newrelic.ingest.sendEvents
    version: 1
    inputs:
      attributes:
        colour: red
        id: 1234
      events:
        - eventType: HeartBeat
          test: "OK"
          attributes:
            foo: bar
        - eventType: HeartBeat1234
          test: "OK1234"
          attributes:
            foo: bar
        - eventType: HeartBeat12345
          test: "OK12345"
          attributes:
            foo: bar
            colour: yellow
        - eventType: HeartBeat12345678
          test: "OK12345678"
      selectors:
        - name: success
          expression: ".success"

Expected output:

{
  "success": true
}

Retrieve events:

After successfully executing a workflow, you can retrieve the associated event by running a query under the account that executed the workflow:

SELECT * FROM HeartBeat

Send logs to New Relic

Input Field	Optionality	Type	Example
attributes	Optional	map	`"{\"page\": \"1\", \"limit\": \"10\"}"`
logs	Required	list	`"[{\"message\":\"XYZ\",\"attributes\":{\"foo\":\"bar\"}}, {\"message\":\"ABC\",\"value\":\"1234\",\"attributes\":{\"color\":\"red\"}}]"`
licenseKey	Optional	string	`"{{ .secrets.secretName }}"`
selectors	Optional	list	`[{\"name\": \"success\", \"expression\": \".success\"}]`

Important

attributes: Common attributes included in all logs when provided. If a log item specifies the same attribute, it overrides the common definition.
logs: The list of log data. Note that the maximum logs allowed per request is 100.
licenseKey: The New Relic Account License Key that specifies the target account where logs are sent. If not provided, a default license key is assumed based on the account executing the workflow. See License Key for more information.
selectors: The selectors to get only the specified parameters as output.

Output Field	Type	Example
success	Boolean	`true`
errorMessage	string	`"Error message if operation failed"`

Workflow example
`name: heartbeat_newrelicIngestSendLogs workflowInputs: cellName: type: String steps: - name: runAction type: action action: newrelic.ingest.sendLogs version: 1 inputs: attributes: colour: red id: 1234 logs: - message: 'Heartbeat sendLogs Action Test Message' attributes: foo: bar - message: 'HeartBeat1234' attributes: foo: bar - message: 'HeartBeat12345' attributes: foo: bar colour: yellow - message: 'HeartBeat12345678' selectors: - name: success expression: ".success"` Expected output: `{ "success": true }` Retrieve logs: After successfully executing a workflow, you can retrieve the associated log by running a query under the account that executed the workflow: `SELECT * FROM Log`

Workflow example

name: heartbeat_newrelicIngestSendLogs

workflowInputs:
  cellName:
    type: String

steps:
  - name: runAction
    type: action
    action: newrelic.ingest.sendLogs
    version: 1
    inputs:
      attributes:
        colour: red
        id: 1234
      logs:
        - message: 'Heartbeat sendLogs Action Test Message'
          attributes:
            foo: bar
        - message: 'HeartBeat1234'
          attributes:
            foo: bar
        - message: 'HeartBeat12345'
          attributes:
            foo: bar
            colour: yellow
        - message: 'HeartBeat12345678'
      selectors:
        - name: success
          expression: ".success"

Expected output:

{
  "success": true
}

Retrieve logs:

After successfully executing a workflow, you can retrieve the associated log by running a query under the account that executed the workflow:

SELECT * FROM Log

NerdGraph actions

Executes a Graphql command against newrelic NerdGraph API. The command can either be a query or a mutation.

Input	Optionality	Type	Description	Example
graphql	Required	string	A GraphQL syntax. You should use GraphiQL to build and test your command
variables	Required	map[string]any	Any key/value pair variables to use with the GraphQL statement.
selectors	Optional	List	The selectors to get the only specified parameters as output.	`steps: - name: findingVar type: action action: newrelic.nerdgraph.execute version: 1 inputs: graphql: \| query GetEntity($entityGuid: EntityGuid!) { actor { entity(guid: $entityGuid) { alertSeverity } } } variables: entityGuid: ${{ .workflowInputs.entityGuid }} - name: findingInline type: action action: newrelic.nerdgraph.execute version: 1 inputs: graphql: \| { actor { entity(guid: "${{ .workflowInputs.entityGuid }}") { alertSeverity } } } selectors: - name: entities expression: '.data'`

Input

Optionality

Type

Description

Example

graphql

Required

string

A GraphQL syntax. You should use GraphiQL to build and test your command

variables

Required

map[string]any

Any key/value pair variables to use with the GraphQL statement.

selectors

Optional

List

The selectors to get the only specified parameters as output.

steps:
    - name: findingVar
      type: action
      action: newrelic.nerdgraph.execute
      version: 1
      inputs:
        graphql: |
          query GetEntity($entityGuid: EntityGuid!) {
            actor {
              entity(guid: $entityGuid) {
                alertSeverity
              }
            }
          }
        variables:
          entityGuid: ${{ .workflowInputs.entityGuid }}
    - name: findingInline
      type: action
      action: newrelic.nerdgraph.execute
      version: 1
      inputs:
        graphql: |
          {
            actor {
              entity(guid: "${{ .workflowInputs.entityGuid }}") {
                alertSeverity
              }
            }
          }
        selectors:
          - name: entities
            expression: '.data'

Output	Type	Description
data	map[string]any	Contents of the `data` property of a NerdGraph response.
success	Boolean	Status of the request.s
errorMessage	String	Failure reason as message.

Example
`steps: - name: currentUserId type: action action: newrelic.nerdgraph.execute version: 1 inputs: graphql: \| query userId { currentUser { id } } - name: sayHello type: action action: example.messaging.sayHello version: 1 inputs: name: ${{ .steps.currentUserId.outputs.data.currentUser.id }}`

Example

steps:
  - name: currentUserId
    type: action
    action: newrelic.nerdgraph.execute
    version: 1
    inputs:
      graphql: |
        query userId {
          currentUser {
            id
          }
        }
  - name: sayHello
    type: action
    action: example.messaging.sayHello
    version: 1
    inputs:
      name: ${{ .steps.currentUserId.outputs.data.currentUser.id }}

Query actions

Executes a cross-accounts NRQL query through the NerdGraph API.

Input	Optionality	Type	Description	Example
query	Required	string	The NRQL query statement.
accountIds	Optional	list of int	The New Relic Account ID input is a list of target IDs that allows you to specify the target accounts where the query is executed against. If this value is not provided as an input, the query will automatically be executed against the account associated with the workflow's execution account.
selectors	Optional	list	The selectors to get the only specified parameters as output.	`steps: - name: queryForLog type: action action: newrelic.nrdb.query version: 1 inputs: accountIds: [12345] query: FROM Log SELECT * WHERE message LIKE 'DEMO%' selectors: - name: resultsAsString expression: '.results \| tostring'`

Output	Type	Example
results: An array of objects containing the results of the query.		`{ results=[ { message=[INFO] - Workflow: test has ended, messageId=39af98 }, { message=[INFO] - Workflow: test - Step query has started, messageId=649c612 }, ... ] }`

Notifications actions

Sends a message to a channel, integrated with destinations for example slack

Input	Optionality	Type	Description	Example
type	Required	string	Type of newrelic destination	`slack`
destinationId	Required	String	DestinationId associated with the newrelic destination.	`123e4567-e89b-12d3-a456-426614174000`
parameters	Required	map	Fields required to send notification to chosen destination type.	`{\"channel\": \"${{ YOUR_CHANNEL }}\", \"text\": \"Enter your text here\"}`
selectors	Optional	list	The selectors to get the only specified parameters as output.	`[{\"name\": \"success\", \"expression\": \".success\"}]`

Output	Type	Example
success	boolean	`true/false`

Sends a message to a MS team channel, integrated with destinations.

Input Field	Optionality	Datatype	Description	Example
destinationId	Required	String	DestinationId associated with the newrelic destination. Refer New Relic integration for Microsoft Teams for steps on how to configure a new destination and listing destination Id. Refer Destinations to know more about destinations.	`123e4567-e89b-12d3-a456-426614174000`
teamName	Required	String	Team name associated with given destination id	`TEST_TEAM`
channelName	Required	String	Channel name where message need to be sent	`StagingTesting`
message	Required	String	Text message which need to be sent	`Hello! this message from Workflow`
selectors	Optional	List	The selectors to get the only specified parameters as output.	`[{\"name\": \"success\", \"expression\": \".success\"}]`

Output Field	Type	Example
success	Boolean	`true/false`
sessionId	String	`"sessionId": "7fa97f26-3791-492e-a39b-53793163dfb9"`
errorMessage	String	`Message is a required field in the notification send"`

Workflow example
`name: msTeam_notification_workflow description: This is a test workflow to test MSTeam notification send action steps: - name: SendMessageUsingMSTeam type: action action: newrelic.notification.sendMicrosoftTeams version: 1 inputs: destinationId: acc24dc2-d4fc-4eba-a7b4-b3ad0170f8aa channel: DEV_TESTING teamName: TEST_TEAM_DEV message: Hello from Workflow`

Workflow example

name: msTeam_notification_workflow
description: This is a test workflow to test MSTeam notification send action
steps:
  - name: SendMessageUsingMSTeam
    type: action
    action: newrelic.notification.sendMicrosoftTeams
    version: 1
    inputs:
      destinationId: acc24dc2-d4fc-4eba-a7b4-b3ad0170f8aa
      channel: DEV_TESTING
      teamName: TEST_TEAM_DEV
      message: Hello from Workflow

Sends a email to NewRelic email destinations with or without attachments

Input Field	Optionality	Datatype	Description	Example
destinationId	Required	String	DestinationId associated with the newrelic destination. Refer New Relic integration for Microsoft Teams for steps on how to configure a new destination and listing destination Id. Refer Destinations to know more about destinations.	`123e4567-e89b-12d3-a456-426614174000`
subject	Required	String	Subject of email	`workflow-notification`
message	Required	String	Message which need to be send in email	`Hello! from Workflow Automation`
attachments	Optional	List	A list of optional attachment
attachment.type	Required	Enum	One of: `QUERY`, `RAW`
attachment.query	Optional	String	For `QUERY` type, this is NRQL query statement.	`SELECT * FROM LOG`
attachment.accountIds*	Optional	List	For `QUERY`, the New Relic Account IDs to execute the query. If not provided, the account associated with the workflow's execution is used.	`[12345567]`
attachment.format	Optional	Enum	For `QUERY`, specify the type for the results, default `JSON`	`JSON CSV`
attachment.content	Optional	String	For `RAW`, this is the content to for the attachment in UTF-8.	`A,B,C\n1,2,3`
attachment.filename	Optional	String	A filename for the attachment	`log_count.csv`
selectors	Optional	List	The selectors to get the only specified parameters as output.	`[{\"name\": \"success\", \"expression\": \".success\"},{\"name\": \"attachments\", \"expression\": \".response.attachments\"},{\"name\": \"sessionId\", \"expression\": \".response.sessionId\"}]`

Output Field	Type	Example
success	Boolean	`true/false`
sessionId	String	`"sessionId": "7fa97f26-3791-492e-a39b-53793163dfb9"`
errorMessage	String	`Channel is a required field in the notification send"`
attachments	List	`[{ "blobId": "43werdtfgvhiu7y8t6r5e4398yutfgvh", "rowCount": 100 }]`

Workflow example
name: email_testing_with_attachment description: Workflow to test sending an email notification via NewRelic with log step workflowInputs: destinationId: type: String steps: - name: sendEmailNotification type: action action: newrelic.notification.sendEmail version: '1' inputs: destinationId: ${{ .workflowInputs.destinationId }} subject: "workflow notification" message: "Workflow Email Notification Testing from local" attachments: - type: QUERY query: "SELECT * FROM Log" format: JSON filename: "log_count.json" selectors: - name: success expression: '.success' - name: sessionId expression: '.response.sessionId' - name: attachments expression: '.response.attachments' - name: logOutput type: action action: newrelic.ingest.sendLogs version: '1' inputs: logs: - message: "Hello from cap check Testing staging server user2 : ${{ .steps.sendEmailNotification.outputs.result.attachments }}" licenseKey: ${{ :secrets:STAGING_NEW_RELIC_LICENSE_KEY }}

Workflow example

name: email_testing_with_attachment
description: Workflow to test sending an email notification via NewRelic with log step
workflowInputs:
  destinationId:
    type: String
steps:
  - name: sendEmailNotification
    type: action
    action: newrelic.notification.sendEmail
    version: '1'
    inputs:
      destinationId: ${{ .workflowInputs.destinationId }}
      subject: "workflow notification"
      message: "Workflow Email Notification Testing from local"
      attachments:
        - type: QUERY
          query: "SELECT * FROM Log"
          format: JSON
          filename: "log_count.json"
      selectors:
        - name: success
          expression: '.success'
        - name: sessionId
          expression: '.response.sessionId'
        - name: attachments
          expression: '.response.attachments'
  - name: logOutput
    type: action
    action: newrelic.ingest.sendLogs
    version: '1'
    inputs:
      logs:
        - message: "Hello from cap check Testing staging server user2 : ${{ .steps.sendEmailNotification.outputs.result.attachments }}"
      licenseKey: ${{ :secrets:STAGING_NEW_RELIC_LICENSE_KEY }}

preview

Prerequisites

Data ingest actions

Send custom events to New Relic

Important

Send logs to New Relic

Important

NerdGraph actions

Execute a GraphQL query or mutation against New Relic NerdGraph API

Query actions

Run a NRDB query

Notifications actions

Send Notification to NewRelic Destination

Sends Notification to NewRelic Microsoft Teams

NerdGraph Query to get destinationId

Sends Notification to NewRelic Email

NerdGraph Query to get destinationId

New Relic actions

preview

Prerequisites.css-21sua1{background:none;border:none;width:0;padding:0;}

Data ingest actions

Send logs to New Relic

NerdGraph actions

Execute a GraphQL query or mutation against New Relic NerdGraph API

Query actions

Run a NRDB query

Notifications actions

Send Notification to NewRelic Destination

Sends Notification to NewRelic Microsoft Teams

NerdGraph Query to get destinationId

Sends Notification to NewRelic Email

NerdGraph Query to get destinationId

Prerequisites