New Relic · Schema

CustomEvent

A custom event to record. Must include eventType. All other attributes are user-defined key-value pairs. Attribute names must not start with nr. (reserved). Values can be strings, numbers, or booleans.

AnalysisAnalyticsAPMDevOpsInfrastructureMonitoringObservabilityPerformancePlatform

Properties

Name	Type	Description
eventType	string	The type of event. Used as the NRDB event table name. Must match the pattern [a-zA-Z0-9:_ ]+, max 255 characters.
timestamp	integer	Unix epoch timestamp in seconds. If omitted, the current time is used. Cannot be more than 48 hours in the past or 24 hours in the future.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/new-relic/refs/heads/main/json-schema/event-api-custom-event-schema.json",
  "title": "CustomEvent",
  "description": "A custom event to record. Must include eventType. All other attributes are user-defined key-value pairs. Attribute names must not start with nr. (reserved). Values can be strings, numbers, or booleans.",
  "type": "object",
  "properties": {
    "eventType": {
      "type": "string",
      "description": "The type of event. Used as the NRDB event table name. Must match the pattern [a-zA-Z0-9:_ ]+, max 255 characters.",
      "maxLength": 255,
      "example": "standard"
    },
    "timestamp": {
      "type": "integer",
      "description": "Unix epoch timestamp in seconds. If omitted, the current time is used. Cannot be more than 48 hours in the past or 24 hours in the future.",
      "example": 1718153645993
    }
  },
  "required": [
    "eventType"
  ],
  "additionalProperties": {
    "description": "Additional user-defined event attributes",
    "oneOf": [
      {
        "type": "string",
        "maxLength": 4096
      },
      {
        "type": "number"
      },
      {
        "type": "boolean"
      }
    ]
  }
}