---
title: "F5 Beacon Integration with Catchpoint"
slug: "f5-beacon-integration-with-catchpoint"
updated: 2023-01-06T15:49:41Z
published: 2023-01-06T15:49:41Z
canonical: "docs.catchpoint.com/f5-beacon-integration-with-catchpoint"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.catchpoint.com/llms.txt
> Use this file to discover all available pages before exploring further.

# F5 Beacon Integration with Catchpoint

## **Introduction**

F5 Beacon provides application visibility and analytics to gain insight into the end-user experience. With this integration, we are expanding on the proactive monitoring checks provided by F5 Beacon by allowing users to set up additional tests in Catchpoint and then view the health of the test in the F5 beacon dashboard. This will enable us to get comprehensive health visibility throughout the application in terms of end-user experience.

Test Webhook Data in Catchpoint is being used to send data to F5 Beacon after each run. Based on the test run success or failure, a status of Available or Failure will be sent to F5 Beacon.

## **Prerequisites**

- F5 Beacon account

## **Installation & Configuration**

#### **Setup in F5 Beacon Portal**

1.  Token Configuration in F5 Beacon portal, step by step instruction <a     href="https://clouddocs.f5.com/cloud-services/beacon-getting-started/token.html#gui-token-creation"     target="_self">here</a>. 
2.  Create a Beacon application in the F5 Beacon portal, step by step     instruction <a     href="https://clouddocs.f5.com/cloud-services/beacon-getting-started/beacon_app.html#creation-steps"     target="_self">here</a>.

**Note**: For this example, you can create a beacon application with just one node, as shown below.

<img src="https://clouddocs.f5.com/cloud-services/beacon-getting-started/_images/dns_node.png" width="438" height="107" alt="dns_node" />

#### **Setup in Catchpoint Portal**

1.  Set up a DNS test and enable **Test Data Webhook** under **Advanced Settings**. 
2.  Navigate to the **API** page under **Settings** in the main menu. 
3.  Set up a **Test Data Webhook** with the details shown in the screenshot and template below.<img     src="https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360069730311-mceclip0.png"     width="628" height="192" alt="mceclip0.png" />     - URL: <https://ingestion.ovr.prd.f5aas.com:50443/beacon/v1/ingest>

- Use the following JSON structure data when creating the template in Test Data Webhook. Replace `<token_here>` with your token.
~~~
{
	"sourceName": "CP ${TestType} ${TestId}",
	"sourceDescription": "${TestType} test healthStatus",
	"token": "<token_here>",
	"components": [
	    {
	        "name": "${TestType} ${TestId}",
	        "description": " ${TestType} test set up in Catchpoint",
	        "healthStatus": "${switch("${errorany}","False","AVAILABLE","false","AVAILABLE","CRITICAL")}"
	    }
	]
}
~~~
#### **Link Catchpoint Data in F5 Beacon Portal**

Before you can link the Catchpoint data, you need to confirm that it is available in the F5 Beacon portal by following these steps:

1.  Log into the F5 Beacon portal. 
2.  Select **Configuration**. 
3.  Click on **Sources**. 
4.  If the data from Catchpoint is reaching F5 Beacon successfully, then the **Test ID** from Catchpoint should be displayed as shown in the screenshot below. ![mceclip0.png](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360069883631-mceclip0.png)

Follow these steps to link the data:
1.  Log in to F5 Beacon portal. 
2.  Open the **Beacon** application from **Application Landscape** and then **List View**. 
3.  Click on the application name. 
4.  Click to enable edit mode. 
5.  Select the DNS node you created earlier. 
6.  Click on **Edit Node** from the top menu. 
7.  Click on **Save** and **Continue** to load **Metric Health Condition**. 
8.  Click on the **Add** button. 
9.  Select **Pick a source type** and choose  **beacon-health-source**. 
10. Under **Select filters**, choose a name, and for value input **Test ID** and select. 
11. Click on **Add**. 
12. Click on **Save**. 
13. Last click on **Save** and **Close**.

## **Results**

Once linked, it takes about a minute to load the data. Refresh the page to see the change in the **List View** page.

<img src="https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360069883691-mceclip1.png" width="204" height="110" alt="mceclip1.png" />

The **Health Status** will change to indicate a successful data connection.

<img src="https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360069883711-mceclip2.png" width="201" height="90" alt="mceclip2.png" />

To view the data, click on the heart icon, and a side-panel will open displaying the dashboard.

<img src="https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360069883751-mceclip4.png" width="559" height="373" alt="mceclip4.png" />
