New Relic destination
Beta
Data Destinations is currently available as a Private Beta product and the information contained in this document is subject to change. Data Destinations is not a HIPAA Eligible Service or PCI compliant and should not be enabled in workflows that are subject to HIPAA or PCI. To learn more, see Private beta legal information.
New Relic is an observability platform that lets you turn Twilio events into custom events you can query with NRQL, chart on dashboards, and alert on alongside your other telemetry.
- Category: Analytics, Performance monitoring
- Release status: Beta
- Authentication: API key
- Regional availability: US1
Get early access to native destinations for data warehouses, observability tools, and event pipelines.
You can send all Event Types supported by Event Streams to New Relic. There's no user-identifier restriction for this destination.
Before you set up a New Relic destination, make sure you have:
- A New Relic account and its Account ID.
- A New Relic License (ingest) key for that account. The New Relic Event API doesn't accept Browser, Mobile, or User keys. Only a License key can write to it.
Info
See Set up a destination for the full UI and Destinations API setup flow common to every destination type.
To create a New Relic destination in the Twilio Console:
- From your New Relic account, gather the settings listed in Destination settings.
- In the Twilio Console, go to Data > Data Destinations > Destinations > Add destination subscription.
- Complete the Add destination subscription wizard.
To create a New Relic destination through the Destinations API, send a POST request to the Destinations endpoint and set destinationType to new-relic. For authentication and the other request body fields, see Create a destination.
POST "https://destinations.twilio.com/v1/ControlPlane/Destinations"
Set the config object in the request body as follows:
| Name | Type | Description |
|---|---|---|
accountId (Required) | string | New Relic account ID, used in the ingest URL path. |
credentials.credentialType (Required) | string | Set to API_KEY. |
credentials.apiKey (Required) | string | Your New Relic license (ingest) key. The Event API rejects browser, mobile, and user keys. |
The following example shows a request body. Replace the uppercase placeholder values with your own.
1{2"destinationType": "new-relic",3"name": "My New Relic destination",4"config": {5"accountId": "ACCOUNT_ID",6"credentials": {7"credentialType": "API_KEY",8"apiKey": "API_KEY"9}10}11}
Use new-relic as the destinationType.
| Field | Description | Required | Default or choices |
|---|---|---|---|
| Account ID | New Relic account ID, used in the ingest URL path. | Yes | None |
| License Key | New Relic License (ingest) key, sent in the Api-Key header. Sensitive: stored encrypted. | Yes | None |
Twilio sends events to the New Relic Event API using the License Key you provide, scoped to the Account ID you configure. New Relic stores only string and numeric attribute values. It silently drops booleans, nulls, and attributes past its per-event cap at ingest.
| Field | New Relic field |
|---|---|
| Event type | eventType (derived from the CloudEvent type, renamed to fit New Relic naming rules) |
| Event time | timestamp |
| Event payload | Spread as top-level custom attributes |
When you save a New Relic destination, Twilio validates your License Key with a non-ingesting write to the Event API. This check doesn't store any event data. The New Relic read APIs require a separate User key, which this destination doesn't collect, so a write-based check is the most Twilio can verify. It confirms your License Key is valid, but it can't fully confirm your Account ID is correct, because an unexpected status from New Relic can indicate either problem.
Twilio doesn't currently offer a way to manually trigger a test event for this destination, from either the Console or the CLI. To confirm delivery is working, wait for a real event of a subscribed type to fire.
New Relic doesn't confirm storage synchronously. Check your New Relic account for the event a few moments after it fires.
| Cause | What you'll see | Fix |
|---|---|---|
| Invalid, expired, or wrong-type License Key | Validation fails with an authentication error | Confirm you're using a License (ingest) key, since Browser, Mobile, and User keys are rejected |
| Account ID incorrect | Validation returns an unexpected status | Re-check your New Relic Account ID |
| Event dropped for an unrepresentable attribute value | No error at save time. The event still delivers with some attributes silently omitted | Ensure attribute values are strings or numbers, since booleans and nulls aren't stored |
| Event batch exceeds the New Relic payload size limit (413) | Delivery errors reported in the Debugger. Not retried, since the New Relic size cap is fixed | Reduce your event volume per subscription, or check for an oversized event payload |
If Twilio can't deliver events to New Relic, Twilio sends an error notification to the Debugger (available in US1 region only). If Twilio continues to encounter delivery errors, Twilio notifies you every 20 minutes after the initial error.