Notification webhook payloads

As an ArcGIS Monitor administrator, you can configure notifications to send webhooks when specific events occur. Once a webhook is triggered, a payload is delivered to the specified webhook URL. Each webhook payload follows a similar JSON schema, containing information that is relevant to the event that triggered the payload. The sections below define the properties included in the payloads and provide an example of a webhook payload.

Payload properties

The following table lists the properties included in webhook payloads for notifications.

Property	Description
id	The ID of the notification that delivered the webhook.
name	The name of the notification that delivered the webhook.
monitor_url	The URL of the ArcGIS Monitor deployment that delivered the webhook.
version	The version of the Monitor deployment that delivered the webhook.
sent_at	The time that the webhook was delivered.
trace_id	The unique ID of the webhook.
operation	The type of operation that was performed. The following are valid operations: Add Update Delete
resource	The item type on which the operation was performed.
occurred_at	The time the operation was performed.
attributes	The attributes associated with the specific event triggers. The following is a list of the attributes and properties included in the payload: Alerts Collections Components Incidents Observers

Notification Payload example

The following is an example of a notification webhook payload that triggers when an alert has been updated:

{
  "info": {
    "id": "11",
    "name": "Production system events",
    "monitor_url": "https://monitorserver.domain.com/arcgis/",
    "version": "2023.0.0",
    "sent_at": 1543192196521,
    "trace_id": "c18bc20f-1267-4cee-85dd-324755675457"
  },
  "events": [
    {
      "operation": "update",
      "resource": "alerts",      
      "occurred_at": 1543192196521,
      "attributes": {
        …
      }
    }
  ]
}