• English日本語한국어
  • Log inStart now

Customize your webhook payload


We're replacing notification channels with more powerful workflows. Existing notifications will be automatically migrated to workflows that provide more options, flexibility, and control, and you can enrich notifications with additional data. Learn about workflows.

If you use webhooks as your alerts notification channel, you can use the default values. You can also customize the payload in the POST message for further integration into your system.

Define webhooks

When defining JSON webhooks, use the format "name":"value",. For example:


When defining static webhook variables in a form payload, use the format name="value". For example:


Do not include any custom, self-signed SSL certificates in your webhook. Our agents enable SSL by default. Due to our security policy, custom SSL certificates will not be imported into our Trust store. Webhooks with the $METADATA variable for synthetic monitoring multi-location failure conditions are currently not supported.

Webhook values

We support these default dynamic webhook values. For your convenience, they're listed in alphabetical order, but you can define your webhook values in any order. You may also add custom variables by using your own key/value pairs such as "Error Type": "My Error".





Possible values: New Relic account ID (string)



Possible values: New Relic account name (string)









This includes the description field from the alert condition, if there is one.



Possible values: (user-defined string)



Possible values: [open|acknowledged|closed]







Possible values: [INCIDENT]









Currently used only for Synthetic monitoring multi-location failure conditions.

Possible values: (object)









Possible values: (user-defined string)







Possible values: [CRITICAL]



The $TARGETS variable cannot be used with FORM data, but is compatible with JSON data.

For static NRQL faceted alerts, the name of the facet that triggered the alert will be populated in the target’s name field.

For a description of the available fields, see Target values.





A human-readable timestamp in the YYYY-MM-DD, HH:MM UTC format.







Targets values

This section describes the $TARGETS field in your webhook. This data is not customizable and is provided here for reference. Your $TARGETS contain a list of zero or more targets (entities). Each target is described by a JSON object with the following fields.




ID of the target or entity


Name of the target or entity


Combined entity tags and NRQL facets that are derived from the condition evaluation and available entity tags.


URL link to this target or entity.


Type of product for this target or entity; for example, APM


Type of target or entity under product; for example, Application

Webhook format example

The following examples show a webhook payload using both the default dynamic variables and a custom variable. You can use some or all of the dynamic variables, along with any custom variables, to define your own payload.

Copyright © 2023 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.