Customize webhook payload

Last published : Nov 20, 2026
Admins can now customize alert webhook payloads to better support workflow automation, including ticket creation, proactive monitoring, issue triage, and auto-remediation.

What exists today and what are the major customer pain points?

Today, Monitor's alert webhook sends a static, non-negotiable payload: {"text": "$PAYLOAD"}. Alert information like priority, target, policy name, timestamp, affected machines, impacted users, etc. are squashed into a single string inside the "text" key. The current payload structure is as below –
{ "alerts": [ { "app_key": "", "text": "{\"Address\":\"...\",\"NotificationId\":\"fdcbc38f-...\",\"NotificationState\":\"NotificationActive\",\"Priority\":\"Critical\",\"Target\":\"Global_WSCloud_Desktops_NPSU_DEV_D0_RPA\",\"Condition\":\"Unregistered machines...\",\"Value\":\"2\", ...}" } ] }
This payload format creates significant friction for admins who want to automate their operational workflows based on alert notifications. Admins utilize various downstream systems to automate their workflows for incident management, monitoring, triage pipelines, and auto-remediation. These downstream systems, like BigPanda, ServiceNow, Datadog, etc., expect data in a structured JSON format with discrete key-value pairs and predictable field names. But since the current webhook payload compresses all the details into a single text string, mapping the payload data to respective downstream fields requires custom parsers. Building the custom parsers adds engineering effort, increases implementation time, and also introduces maintenance overhead whenever the payload content changes. More importantly, it can delay ticket creation, slow incident triage, reduce the accuracy of automated routing, and limit customers’ ability to trigger proactive remediation. For organizations that depend on fast response times and consistent operations, this gap can lead to longer mean time to acknowledge and resolve issues, higher operational cost, and greater risk of service disruption.

What’s changing?

The custom webhook payload feature adds a Custom Payload toggle to the Create/Edit Webhook form. Admins can use this option to decide whether the configured webhook URL receives the default static payload or a customized payload. To maintain backward compatibility, webhooks continue to send the current static payload when the toggle is turned off. When the toggle is turned on, the static payload is replaced with a structured key-value mapping editor. This editor enables customers to select fields from the alert schema and define custom JSON key names for each selected field.

How it works?

Admin chooses the payload mode – Static or Customize. For custom payload, Admin defines the JSON key names that their downstream tool expects (e.g., NotificationId, Priority, Target) and maps them to a Citrix source field picked from the dropdown. The webhook engine substitutes real alert data at fire time. When setting up a custom payload, Admins can preview and validate the payload, before saving it. Server-side validation will reject the payloads with zero mappings, empty key names, or duplicate key names.
Following source fields are available for mapping –
Source field Description
NotificationId Unique ID of the alert notification
NotificationState Alert state (Active, Resolved)
Priority Alert priority (High, Medium, Low)
PolicyName Name of the alert policy that triggered
Condition Alert condition expression (e.g., "CPU > 90")
Value Metric value that triggered the alert
Timestamp Time the alert fired
Scope Scope of the alert (Site, DeliveryGroup, Machine)
Site Site name
Description Alert description
ImpactedUsers Number of impacted users
AffectedServers List of affected servers
AffectedMachines List of affected machines
In addition to the above, following source fields are available for alerts with automated actions –
Source field Description
ActionType Type of automated action taken
ActionStatus Status of the action (Success, Failed)
ActionTimestamp Time the action executed
ActionTotalTargets Total targets the action ran against
ActionSuccessTargets Targets where the action succeeded
ActionFailedTargets Targets where the action failed
ActionSkippedTargets Targets skipped (requires additional toggle)

How it works?

Let’s say you want to automate incident creation for alerts in ServiceNow.
Step 1 – Navigate to “Integrations and data exports”. Go to “Alerting and ITSM”. Create a new webhook profile.
Step 2 – Enter you ServiceNow inbound webhook URL. Turn on the Custom Payload toggle.
Step 3 – Build the mapping expected by the ServiceNow inbound restAPIs in the editor. See example below:
JSON Key Name (what ServiceNow expects) Source Field (from Citrix Monitor)
correlation_id NotificationId
short_description Condition
urgency Priority
cmdb_ci AffectedMachines
assignment_group Scope
opened_at Timestamp
description Description
impacted_user_count ImpactedUsers
Step 4 – Click on “Preview Payload”. The editor renders a sample JSON with placeholder values so you can validate the structure before saving.
This completes the setup. When an alert fires, Monitor's webhook engine substitutes the real alert data into the saved mapping and delivers this to ServiceNow, which will create the incident with delivered parameters.
On the PowerShell side, existing cmdlets, Add-MonitorWebhookProfile and Set-MonitorWebhookProfile, remains unchanged. Three new cmdlets have been added along with the existing ones –
  • Set-MonitorWebhookProfileCustomPayload – Creates new profile when -Uid omitted, updates existing profile when -Uid is supplied; params -Name, -Description, -Url, -Headers, -PayloadMappings, -Platform, -Type, -MethodType,
  • Get-MonitorWebhookProfileCustomPayload – By -Uid or -Name
  • Test-MonitorWebhookConfigurationCustomPayload – To resolve the mappings against sample alert values to sanity-check a Custom profile without firing a real alert. params -Url, -Headers, -MethodType, -PayloadMappings.
Remove-MonitorWebhookProfile covers both modes and can be used to remove existing webhook profiles.