New Relic Integration

Overview

Add New Relic to any ModuleX agent or workflow. Query observability data and record deployments in New Relic. Run NRQL queries, search monitored entities, fetch entity details, and create deployment change events through New Relic’s NerdGraph GraphQL API (api.newrelic.com/graphql, or api.eu.newrelic.com/graphql for the EU region).

Categories: Monitoring & Observability · Monitoring · Observability · Auth: API Key · Actions: 4

Authentication

API Key Authentication

Authenticate using your New Relic user API key

Step 1

Step 2

Open the user menu and go to ‘API keys’

Step 3

Create a new ‘User’ key (its value starts with ‘NRAK-’)

Step 4

Paste the API key below

Required Credentials

Field	Description	Required	Format
New Relic User API Key	Your New Relic user API key (starts with ‘NRAK-’)	Yes	`NRAK-<your-user-key>`

Available Actions

nrql_query — Run a NRQL query against a New Relic account using NerdGraph.

Parameters

integer

required

New Relic account ID to query

string

required

NRQL query to execute

string

New Relic data center region: ‘us’ (default) or ‘eu’ (Default: us)

integer

Optional query timeout in seconds

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "results": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Results",
      "type": "array"
    },
    "result_count": {
      "default": 0,
      "title": "Result Count",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "NrqlQueryOutput",
  "type": "object"
}

search_entities — Search New Relic entities by name, GUID, domain type, tags, or reporting state.

Parameters

string

required

Entity search query, e.g. name like “api” or domainType = “APM-APPLICATION”

string

New Relic data center region: ‘us’ (default) or ‘eu’ (Default: us)

string

Pagination cursor from a previous entity search

Response

{
  "$defs": {
    "Entity": {
      "additionalProperties": false,
      "description": "A single monitored New Relic entity (guid, name, entityType).",
      "properties": {
        "guid": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Guid"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "entity_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Entity Type"
        }
      },
      "title": "Entity",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "count": {
      "default": 0,
      "title": "Count",
      "type": "integer"
    },
    "query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Query"
    },
    "entities": {
      "items": {
        "$ref": "#/$defs/Entity"
      },
      "title": "Entities",
      "type": "array"
    },
    "next_cursor": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Next Cursor"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchEntitiesOutput",
  "type": "object"
}

get_entity — Fetch a New Relic entity by GUID.

Parameters

string

required

Entity GUID

string

New Relic data center region: ‘us’ (default) or ‘eu’ (Default: us)

Response

{
  "$defs": {
    "Entity": {
      "additionalProperties": false,
      "description": "A single monitored New Relic entity (guid, name, entityType).",
      "properties": {
        "guid": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Guid"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        },
        "entity_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Entity Type"
        }
      },
      "title": "Entity",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "entity": {
      "anyOf": [
        {
          "$ref": "#/$defs/Entity"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "GetEntityOutput",
  "type": "object"
}

create_deployment_event — Record a deployment change event in New Relic change tracking.

Parameters

string

required

GUID of the entity associated with the deployment

string

required

Deployment version, release name, or commit SHA

string

New Relic data center region: ‘us’ (default) or ‘eu’ (Default: us)

string

Short description of the deployment

string

Longer deployment description

string

Deployment changelog text or URL

string

Commit SHA or identifier associated with the deployment

string

URL to the deployment, build, or release details

string

User or automation that performed the deployment

string

Optional group ID to correlate related changes

object

Custom change event metadata as key-value pairs with string, number, or boolean values

string

Deployment type: ‘basic’, ‘blue green’, ‘canary’, ‘rolling’, or ‘shadow’ (Default: basic)

integer

Event timestamp in milliseconds since Unix epoch

Response

{
  "$defs": {
    "ChangeTrackingEntity": {
      "additionalProperties": false,
      "description": "The entity a change tracking event is associated with.",
      "properties": {
        "guid": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Guid"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        }
      },
      "title": "ChangeTrackingEntity",
      "type": "object"
    },
    "ChangeTrackingEvent": {
      "additionalProperties": false,
      "description": "A created New Relic change tracking (deployment) event.",
      "properties": {
        "category": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Category"
        },
        "category_and_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Category And Type"
        },
        "change_tracking_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Change Tracking Id"
        },
        "custom_attributes": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Custom Attributes"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Description"
        },
        "group_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Group Id"
        },
        "short_description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Short Description"
        },
        "timestamp": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Timestamp"
        },
        "type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Type"
        },
        "user": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "User"
        },
        "entity": {
          "anyOf": [
            {
              "$ref": "#/$defs/ChangeTrackingEntity"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        }
      },
      "title": "ChangeTrackingEvent",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "event": {
      "anyOf": [
        {
          "$ref": "#/$defs/ChangeTrackingEvent"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "messages": {
      "items": {
        "type": "string"
      },
      "title": "Messages",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateDeploymentEventOutput",
  "type": "object"
}

Limits & Quotas

All actions hit the NerdGraph GraphQL endpoint; New Relic enforces account-level NerdGraph rate limits (per-minute request and query-cost budgets). Heavy or unbounded NRQL queries may be throttled or time out.
nrql_query accepts an optional timeout (seconds) forwarded to NerdGraph; the HTTP client itself caps each call at 90 seconds.
create_deployment_event custom attribute names must be letters, numbers, and underscores (not starting with a number), must not contain ., and must avoid New Relic’s reserved NRQL keywords; invalid names are rejected before the call. A supplied timestamp must be within one day of the current time per New Relic’s change tracking rules.
Error model: non-2xx responses, GraphQL errors, and timeouts are caught and returned as success=False + error rather than raising.

Using

Providers

Building

Tools

New Relic Integration for AI Agents & Workflows

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Grafana

Sentry

CrowdStrike

Links

​Overview

​Authentication

​API Key Authentication

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Limits & Quotas

​Related integrations

Grafana

Sentry

CrowdStrike

​Links

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Related integrations

Links