Since templates replace the default payload, the following two macros can be used to instruct Catchpoint to send the default payload, which can then be augmented with additional macros.
JsonPayload - Evaluates to the default JSON Payload sent by the Webhook.
XmlPayload - Evaluates to the default XML Payload sent by the Webhook.
| Macro | Description |
|---|---|
| acrossNodesTrailingValue | The across-node trailing (historical) value, when wesetup Trailing value Alert with node threshold as Average Across Nodes. |
| acrossNodesValue | The across-node value, for across-node alerts. |
| alertCreateDateLocal | The localized timestamp for the alert record in the DB. |
| alertCreateDateLocalEpoch | The Alert-Create-Date-Local-Epoch timestamp, local time. |
| alertCreateDateUtc | The UTC timestamp for the alert record in the DB. |
| alertCreateDateUtcEpoch | The Alert-Create-Date-UTC-Epoch timestamp, UTC time. |
| alertGroupId | The alert-group-ID. |
| alertGroupItemId | The alert-group-item-ID. |
| AlertGroupItemStepTypeValue | Displays the Alert-Group-Item's Step-Type-Value (only applies to non-zero Step-Type-IDs). |
| alertInitialTriggerDateLocalEpoch | The Alert-Initial-Trigger-Date-Local-Epoch timestamp, local time. |
| alertInitialTriggerDateUtcEpoch | The Alert-Initial-Trigger-Date-UTC-Epoch timestamp, UTC time. |
| alertInitialTriggerDateLocal | The Alert-Initial-Trigger-Date-Local timestamp, local time. |
| alertInitialTriggerDateUtc | The Alert-Initial-Trigger-Date-UTC timestamp, UTC time. |
| alertProcessingTimestampUtc | The UTC timestamp for when the alert triggered during alert processing. |
| alertProcessingTimestampUtcEpoch | The Alert-Processing-Timestamp-Utc-Epoch timestamp, UTC time. |
| alertSubTypeId | The alert-sub-type-ID. |
| alertThreshold | Gives the node threshold value when you setup an Alert with #runs/#nodes[Node threshold] |
| alertThresholdPercentage | The node percentage threshold to trigger the alert when you setup an Alert with %runs/%nodes. |
| alertThresholdUsesOrOperator | The flag that indicates if either the 'alertThreshold' or 'alertThresholdPercentage' must occur to trigger the alert. |
| alertTriggerPercentage | The percentage of nodes that triggered at the time of alert processing. |
| alertTriggerTotal | The #-of-nodes that triggered at the time of alert processing. |
| alertTriggerTypeId | The alert-trigger-type-ID. |
| alertTypeId | The alert-type-ID. |
| associatedObjectId | For Insight or Zone alerts, which specifies either the Insight-ID or Zone-ID for the given alert. |
| clientId | The client-ID. |
| clientName | The client name. |
| dataTypeId | The data-type-ID (default=Average, 2=Median, 3=StdDev, etc..) used for determining alert trigger. |
| dataTypeModifier | The data-type modifier, used only if the data-type-ID is set to 18 (Percentage-Custom). |
| displayTestTypeId | The display-test-type-ID. |
| divisionId | The division-ID. |
| divisionName | The division name. |
| dnsGroups | Displays nested dns-group information. |
| dnsQueries | Displays nested dns-query information. This is a child macro of "dnsGroups". |
| dnsQueryErrorMessage | The dns-query-error-message. This is a child macro of "dnsQueries". |
| dnsQueryPing | Displays nested dns-query-ping information. This is a child macro of "dnsQueries". |
| dnsQueryResponseTime | The dns-query-response-time. This is a child macro of "dnsQueries". |
| dnsQueryReturnCode | The dns-query-return-code. This is a child macro of "dnsQueries". |
| dnsQueryServerAddress | The dns-query-servrer-address. This is a child macro of "dnsQueries". |
| dnsQueryServerHostName | The dns-query-server-host-name. This is a child macro of "dnsQueries". |
| dnsQueryServerName | The dns-query-server-name. This is a child macro of "dnsQueries". |
| dnsQueryServerPort | The dns-query-server-port. This is a child macro of "dnsQueries". |
| dnsQueryTraceRoute | Displays nested dns-query-trace-route information. This is a child macro of "dnsQueries". |
| dnsQueryTypeId | The dns-query-type-id. This is a child macro of "dnsQueries". |
| dnsResponseAddress | The dns-response-address. This is a child macro of "dnsResponses". |
| dnsResponseClassId | The dns-response-class-ID. This is a child macro of "dnsResponses". |
| dnsResponseInfo | The dns-response-info. This is a child macro of "dnsResponses". |
| dnsResponseInnerResolveErrorCode | The dns-response-inner-resolve-error-code. This is a child macro of "dnsResponses". |
| dnsResponseInnerResolveTime | The dns-response-inner-resolve-time. This is a child macro of "dnsResponses". |
| dnsResponseName | The dns-response-name. This is a child macro of "dnsResponses". |
| dnsResponses | Displays nested dns-response information. This is a child macro of "dnsGroups". |
| dnsResponseTtl | The dns-response-TTL. This is a child macro of "dnsResponses". |
| dnsResponseTypeId | The dns-response-type-ID. This is a child macro of "dnsResponses". |
| historicalReportTimeIntervalCount | The historical-report-time-interval-count. |
| if | Performs "if", "else if" and "else" expressions using nested macros. Regex is supported with case sensitivity as an option. For example: ${if("${testName}" =~ /abc/i, "match-abc-any-case", "no-match")} |
| insightDataName | The insight-data-name. |
| insightDataSourceId | The insight-data-source-id. |
| insightDataTypeId | The insight-data-type-id. |
| monitorTypeId | The monitor-type-id. |
| mostRecentActualRunTimeEpoch | The Most-Recent-Actual-Run-Time-Epoch timestamp. |
| nodeClientAddress | The node client-address. This is a child macro of "nodeDetails". |
| nodeCounter | The node test-run counter. This is a child macro of "nodeDetails". |
| nodeCounterTriggered | The node triggered test-run counter. This is a child macro of "nodeDetails". |
| nodeDetails | Displays nested node information. |
| nodeErrorKey | The node error-key. This is a child macro of "nodeDetails". |
| nodeErrorValue | The node error-value. This is a child macro of "nodeDetails". |
| nodeHostsFailed | The node #-of-failed hosts, for host-failure alerts. This is a child macro of "nodeDetails". |
| nodeId | The node ID. This is a child macro of "nodeDetails". |
| nodeIsCritical | The node trigger level flag (0=warning, 1=critical). This is a child macro of "nodeDetails". |
| nodeMaxTriggered | The node maximum trigger value. This is a child macro of "nodeDetails". |
| nodeMean | The node mean value. This is a child macro of "nodeDetails". |
| nodeMeanTriggered | The node mean triggered-value. This is a child macro of "nodeDetails". Dependant on alert config and implies mean value of the selected metric per node. The 'nodeDetails' macro splits the details of each node based on the nested sub macros used in it. |
| nodeMedianTriggered | The node median triggered-value. This is a child macro of "nodeDetails". |
| nodeMinTriggered | The node minimum triggered value. This is a child macro of "nodeDetails". |
| nodeName | The node name. This is a child macro of "nodeDetails". |
| nodePageFailureErrorCode | The node page-failure error-code, for page-failure alerts. This is a child macro of "nodeDetails". |
| nodePageFailureExplanationTypeId | The node page-failure explanation-type-ID. This is a child macro of "nodeDetails". |
| nodePageFailureHttpStatusCode | The node page-failure HTTP-status-code, for page-failure alerts. This is a child macro of "nodeDetails". |
| nodeServerAddress | The node server address. This is a child macro of "nodeDetails". |
| nodeSuspectObjectResponse | The node worst-request performance time, for suspect alerts. This is a child macro of "nodeDetails". |
| nodeSuspectPageResponse | The node root-request performance-time, for suspect alerts. This is a child macro of "nodeDetails". |
| nodeThresholdTypeId | The node threshold-type-ID. This is a child macro of "nodeDetails". |
| nodeTrailingValue | Gives the trailing value when we setup an Alert with Node Threshold as #runs/#nodes or %runs/%nodes. This is a child macro of "nodeDetails". |
| nodeTransactionStepIndex | The node transaction-step-index. This is a child macro of "nodeDetails". |
| nodeTransactionStepName | The node transaction-step-name. This is a child macro of "nodeDetails" Example - "stepname":${nodedetails(Node:${nodeName} failed at step name:${nodeTransactionStepName})} |
| nodePageFailureErrorCodeDesc | The node error description. This is a child macro of "nodeDetails" Example - ${nodedetails("error": ${nodePageFailureErrorCode}, "description": ${nodePageFailureErrorCodeDesc})} |
| nodeWorstHost | The node worst-host, for host-failure alerts. This is a child macro of "nodeDetails". |
| nodeWorstHostDetails | The node worst-host-details, for host-failure alerts. This is a child macro of "nodeDetails". |
| notificationLevelId | The notification-level-ID. |
| pingAddress | The ping-address from either the diagnostic-ping information, or from the child macros "traceRouteHops" or "dnsQueryPing". |
| pingAsn | The ping-ASN from either the diagnostic-ping information, or from the child macros "traceRouteHops" or "dnsQueryPing". |
| pingBufferSize | The ping-buffer-size from either the diagnostic-ping information, or from the child macros "traceRouteHops" or "dnsQueryPing". |
| pingDuration | The ping-duration from either the diagnostic-ping information, or from the child macros "traceRouteHops" or "dnsQueryPing". |
| pingFaliureStatus | The ping-failure-status from either the diagnostic-ping information, or from the child macros "traceRouteHops" or "dnsQueryPing". |
| pingFromDebugPrimaryHost | The ping-is-from-debug-primary-host flag (0=false, 1=true) from either the diagnostic-ping information, or from the child macros "traceRouteHops" or "dnsQueryPing". |
| pingHost | The ping-host from either the diagnostic-ping information, or from the child macros "traceRouteHops" or "dnsQueryPing". |
| pingRoundTripTime | The ping-round-trip-time. This is a child macro of "pingRoundTripTimes". |
| pingRoundTripTimes | Displays nested ping-round-trip-time information, from either the diagnostic-ping information, or from the child macros "traceRouteHops" or "dnsQueryPing". |
| productId | The product-ID. |
| productName | The product name. |
| reportDateEpoch | The Report-Date-Epoch timestamp. |
| reportDateLocal | The localized schedule-window report-date. |
| reportDateLocalEpoch | The Report-Date-Local-Epoch timestamp, local time. |
| reportDateUtc | The UTC schedule-window report-date. |
| reportDateUtcEpoch | The Report-Date-Utc-Epoch timestamp, UTC time. |
| reportTimeIntervalId | The report-time-interval-ID which describes the type of alert-test-report-data upon which the alert was triggered. Typically, this will refer to the 5-minute test-report-files. |
| smartboardUrl | The Smartboard URL for the test's alerting window. |
| switch | Performs "switch-case" expressions using nested macros. |
| testId | The test-ID. |
| testName | The test name. |
| TestDescription | Description of the test |
| testPath | Displays the Test-Folder path, enclosed in double-quotes, separated by ">" characters. |
| testTypeId | The test-type-ID. |
| testUrl | The test URL. |
| thresholdReportTimeIntervalCount | The threshold-report-time-interval-count. |
| traceRouteAddress | The trace-route-address, from either the diagnostic trace-route, or from the child macro "dnsQueries". |
| traceRouteDuration | The trace-route-duration, from either the diagnostic trace-route, or from the child macro "dnsQueries". |
| traceRouteErrorCode | The trace-route-error-code, from either the diagnostic trace-route, or from the child macro "dnsQueries". |
| traceRouteHops | Displays nested trace-route-hop information, from either the diagnostic trace-route, or from the child macro "dnsQueries". |
| traceRouteHost | The trace-route-host. This is a child macro of "traceRouteHops". |
| traceRouteTimestamp | The trace-route-timestamp (UTC), from either the diagnostic traceroute, or from the child macro "dnsQueries". |
| transactionStepIndex | The transaction-step-index. |
| triggerOperatorTypeId | The trigger-operator-type-id. |
| triggerRangeEnd | The trigger-range-end. |
| triggerRangeStart | The trigger-range-start. |
| triggerRegexMatch | The trigger-regular-expression, for content-match alerts. |
| zoneName | The zone name, for zone alerts. |
| performanceChartURL | The performance chart URL for the test which max out to 2 hours of time frame |
| scatterplotChartURL | The scatterplot chart URL for the testwhich max out to 2 hours of time frame. |
| waterfallChartURL | Shows up waterfall chart URLs for thefailed test runs when the alert got triggeredby selecting from an hour interval |
| testFolderID | Gets the first parent folder ID. |
| testLink | The link to the test settings and configuration. |
| testLabels | The labels on the test. |
Here is the list of all available alert webhook macros