Test Data Webhook Templates allow you to format the content of test data being sent to the webhook url. Each macro will be replaced at runtime with the actual value collected by Catchpoint.
For example, if your template includes the following section:
{
"key": "test.id",
"value": {
"stringValue": "${Testid}"
}
}
then at runtime, the macro ${Testid} will be replaced with the actual ID of the test that generated the data being exported.
Below are the supported test data macros and their descriptions.
| Macro | Description |
|---|---|
| ${address} | Root Request IP Address |
| ${bytedownload} | FTP Total Download Bytes |
| ${byteget} | FTP Total GET Bytes |
| ${bytereceive} | Total Downloaded Bytes. It is applicable for non HTTP tests like BGP, Imap, Transort, SSH, and Websocket. |
| ${byteresponsecontent} | Root Request Response Content Bytes |
| ${byteresponseheaders} | Root Request Response Header Bytes |
| ${byteresponseselfzone} | Total Self-Zone Bytes |
| ${byteresponsetotalcontent} | Total Response Content Bytes |
| ${byteresponsetotalheaders} | Total Response Header Bytes |
| ${byteupload} | FTP Uploaded Bytes |
| ${counterconnections} | Total Number of Connections |
| ${counterfailedrequests} | Total Number of Failed Requests |
| ${counterfilmstripimages} | Total Number of Filmstrip Images |
| ${counterhosts} | Total Number of Hosts |
| ${counterjsfailures} | Total Number of JS Errors |
| ${counterredirections} | Total Number of Redirects |
| ${counterrequests} | Total Number of Requests |
| ${errorany} | returns "true" if there is an error and "false" for successful test runs |
| ${errorcode} | Error Code of test runs. 0 = Child request errors, null or "" = No errors, and it gives the actual error codes if there is. |
| ${errorconnection} | Connection Error Message |
| ${errordns} | DNS Error Message |
| ${errorload} | Page Load Error Message |
| ${errorloadobjects} | Request Error Message |
| ${errorssl} | SSL Error Message |
| ${errorsystemlimit} | System Limit Error Message |
| ${errortimeout} | Timeout Error Message |
| ${errortransaction} | Transaction Verb Error Message |
| ${globalVariable(<name>)} | Returns the value previously stored using the storeGlobalVariable transaction command. |
| ${if} | If statement |
| ${insightindicator} | Returns the Indicator value for the give Indicator ID
*Insight IDs can be found in the Change Log |
| ${insighttracepoint} | Returns the Tracepoint value for the give Tracepoint ID
*Insight IDs can be found in the Change Log |
| ${jsfailures} | Top 5 JS Error Details |
| ${jsonpayload} | Default JSON Payload that would be sent by the Webhook when not using a template |
| ${monitorversion} | Version of Test Monitor |
| ${pingpacketlosspct} | Ping Packet Loss |
| ${pingroundtriptimeavg} | Ping Round Trip Time |
| ${scorepagespeed} | Page Speed Score |
| ${scorespeedindex} | Speed Index Score |
| ${switch} | Switch Statement |
| ${testurl} | URL of the Test |
| ${timestamp} | Test Timestamp If no parameters are given, then the UTC test time in YYYYMMDDHHMISSMSC will be returned otherwise, the 1st parameter specifies the format. Examples:
|
| ${timestampepoch} | Test Timestamp Epoch |
| ${timingabovethefold} | Above the Fold Time |
| ${timingauth} | Authentication Time |
| ${timingclient} | Client Time |
| ${timingconnect} | TCP Connect Time |
| ${timingcontentload} | Content Load Time |
| ${timingdelete} | FTP Delete Time |
| ${timingdns} | DNS Resolution Time |
| ${timingdocumentcomplete} | Load Event / Document Complete Time |
| ${timingdomcontentloadedevent} | DOM Content Load Time |
| ${timingdominteractive} | DOM Interactive Time |
| ${timingdomload} | DOM Load Time |
| ${timingdownload} | FTP Download Time |
| ${timingfetch} | IMAP Message Fetch Time |
| ${timingget} | FTP GET Time |
| ${timingimpactself} | First Party Zone Impact |
| ${timingimpactthirdparty} | Third Party Zone Impact |
| ${timinglist} | IMAP Message List Time |
| ${timingload} | Load Time (AKA Recevie/Download) |
| ${timinglocalclockoffset} | NTP |
| ${timinglogout} | IMAP Logout Time |
| ${timingredirect} | Total Root Request Redirect Time |
| ${timingrenderstart} | Render Start Time |
| ${timingresponse} | Total Root Request Time |
| ${timingrootdelay} | NTP Root Delay Time |
| ${timingrootdispersion} | NTP Root Dispersion Time |
| ${timingroundtripdelay} | NTP Round Trip Delay Time |
| ${timingsearch} | IMAP Message Search Time |
| ${timingsend} | Send Time |
| ${timingssl} | TLS/SSL Time |
| ${timingtimetotitle} | Time to Title |
| ${timingtotal} | Total Test Time |
| ${timingupload} | FTP Upload Time |
| ${timingwait} | Wait Time (AKA Time to First Byte) |
| ${timingwebpageresponse} | Webpage Response Time |
| ${timingwire} | Wire Time |
| ${xmlpayload} | Default XML Payload that would be sent by the Webhook when not using a template |
Here is the list of all available test data webhook macros