Test Data Webhook Guide

  • 3 minute(s) read
Prev Next

The Test Data Webhook operates via a subscription model. The API consumer, known as a subscriber, has to register a destination URI with the API Publisher. This Publisher posts the data to the destination URI as the data becomes available.

In Catchpoint, you subscribe to the API by specifying a destination URL in the Catchpoint interface. The API subscription applies for the entire division and you can specify on a per test basis if you want to enable the posting of data. Each Catchpoint Agent will push the data to the subscriber via a HTTP Post request, once the enabled test completes its run.

Here is a simple example for a Web test utilizing the Object monitor type:

  1. The Catchpoint Agent starts the test by requesting the Test URL.
  2. The website replies to the request.
  3. The Catchpoint Agent collects measurements and posts them to the API Endpoint URL specified in the Catchpoint Interface.
  4. The API Subscriber receives the data and responds with a 200 OK.

Configuration

To configure the Test Data Webhook in Catchpoint, you must first set up the API subscriber, and then enable which tests to post data for.

Within portal Test Data Webhook can be found under: Integration > Webhook.

Maximum Allowed: 5

Fields:

  1. Name: Will appear in the product dropdown for selection
  2. URL: of the subscriber and the format you wish to receive the data in. This field supports macros, which allows you to pass information like Test ID, Node ID, etc.
  3. Status:
    • Inactive - No data will be sent to this webhook, even if it is enabled for active tests
    • Active - The Webhook will be sent data if it is enabled on active tests.
  4. Format: XML, JSON, Template. (See the below section and separate article for templates)
  5. On Failure Alert: A list of email address to notify in agent fails to post data to the subscriber
  6. Notification Trigger: The number of attempts before sending an email to notify.
    image.png

By default, Catchpoint will not push any data to the subscriber unless the product has been set to use a given webhook and the test has been enabled.

Setting a Test Data Webhook for a Product

Within a given product (shown below), the Test Data Webhook is available to set via a drop down.

States:

  • Enable: Select the Test Data webhook you wish the tests within the product to report to
  • Disable: The product will not report to a Test Data Webhook.
    image.png

Setting up a test to post data to a Test Data Webhook

Go to Test Properties and slide the button for Enable Test Data Webhook, as highlighted below:
image.png

In doing so the given test will report to the Webhook you have configured in the parent product.

Templates

For information regarding Test Data Webhook Templates, see article here.

Post Failure

The Catchpoint Agent will post data to the API Subscriber for each test that is enabled, once the test has completed its run. The agent will consider the API push a failure if it does not receive a "200 OK" response from the subscriber.

For this case, the Catchpoint agent will retry posting the data to the subscriber for up to 9 times in the following 60 minutes. If the subscriber continues to fail, the Catchpoint agent will stop retrying and log a failure. The Catchpoint system will alert the email addresses configured on the API settings page. Users can specify at what point during these retries to receive the notification email.

For more information on Test Data Webhook failure notifications and how they work, see the article here.

Results Format

Catchpoint has chosen to support JSON as the response format in the Catchpoint Test Data Webhook. All requests need to have an accept header containing either */*, application/json, or text/json.