Schema for custom event data payloads submitted to the New Relic Event API. Represents an array of custom event objects, each with a required eventType and any number of user-defined attribute key-value pairs. Events are stored in NRDB and queryable via NRQL.
New Relic Event API Payload is a JSON Structure definition published by New Relic. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/new-relic/refs/heads/main/json-structure/new-relic-event-payload-structure.json",
"name": "New Relic Event API Payload",
"description": "Schema for custom event data payloads submitted to the New Relic Event API. Represents an array of custom event objects, each with a required eventType and any number of user-defined attribute key-value pairs. Events are stored in NRDB and queryable via NRQL.",
"type": "array",
"maxItems": 2000,
"items": {
"$ref": "#/$defs/CustomEvent"
},
"$defs": {
"CustomEvent": {
"type": "object",
"description": "A single custom event. Must include eventType. All other keys are user-defined attributes stored as event fields in NRDB.",
"required": [
"eventType"
],
"properties": {
"eventType": {
"type": "string",
"description": "The event type name used as the NRDB table. Must match [a-zA-Z0-9:_ ]+ and not exceed 255 characters. Cannot start with nr. (reserved).",
"maxLength": 255,
"pattern": "^[a-zA-Z0-9:_ ]+$"
},
"timestamp": {
"type": "int32",
"description": "Unix epoch timestamp in seconds when the event occurred. If omitted, the ingestion time is used. Cannot be more than 48 hours in the past or 24 hours in the future.",
"examples": [
1645564509
]
}
},
"additionalProperties": {
"description": "User-defined event attribute. Keys must not start with nr. (reserved). String values are limited to 4096 characters.",
"oneOf": [
{
"type": "string",
"maxLength": 4096
},
{
"type": "double"
},
{
"type": "boolean"
}
]
}
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.