The Test Data Webhook features supports Templates, which allow you to format the content of test data being sent to the webhook url however the destination system requires.
Implementation:
To create a template:
- Click on the API link in the Settings module.
- In the Test Data Webhook section select the radio button labeled Template, and then click Select Template
- Click Add New in the template selection drop-down menu. (Existing templates can be edited in the menu by hovering over the template name and selecting the Edit/View Properties icon.)
- A box will pop up where you can specify the name, format (text, JSON, or XML) for the template and define its contents.
Macros
Test Data Webhook Macros are text strings in this format: ${macro_name}
At runtime, when data is sent to the webhook, each macro in your template will be replaced with the corresponding value generated by Catchpoint. For example, the macro ${testurl} would be replaced with the Test URL configured in your test that generated the data.
Using a template completely replaces the default JSON or XML payload. If you want to include the default payload in your template, you can do so using the following macros:
${JsonPayload} - the default JSON payload sent by the Webhook when not using a template.
${XmlPayload} - the default XML payload sent by the Webhook when not using a template.