[Endpoint] Status Page Webhook Integration.

  • 2 minute(s) read
Prev Next

Introduction

The status page is one of the top status and incident communication tool and helps keep customers and employees informed during downtime to build trust and cut support costs. It supports collecting and reporting on performance metrics to show performance trends over time, which is a great way to build trust and transparency around your organization and ensure that your page is doing work for you each day. This integration enables you to submit performance data from Catchpoint to Status page.

Prerequisites

  1. Status page admin account.
  2. Catchpoint REST API functionality enabled.

Installation & Configuration

Configuration in Status page – Create Metric:
3. Log in to Statuspage.
4. Click on Your page.
5. Click on System metrics.
6. Click Add a metric to create a new one.
7. Choose Data source as I will submit my own data from this metric.
8. Enter the metric name as Display name.
9. Input the appropriate type of units in the Display Suffix field (e.g., ms, bytes, score).
image.png

image.png

  1. Click Add metrics to save the changes.
  2. The status page displays a script you can use to make a POST request submitting data for the newly created metric. Make a note of this script; it contains your page_id and, which you will use to post data from Catchpoint.

image.png

Configuration in Status page – Create API Key:

  1. In the Status page, click on your profile icon at the top right of the screen.
  2. Click on API info.
  3. If you do not have an API key already created, then click on Create key.
  4. Provide an API key name.
  5. Click Confirm.
  6. Copy the API key so that we can use it to configure Catchpoint portal.

image.png

Configuration in Catchpoint Portal – Test Data Webhook:

  1. Log in the Catchpoint Portal, then go to Settings > API.
  2. Click Add URL.
  3. Enter a Name.
  4. Enter URL, the endpoint where the alert data will be posted, using the following syntax (replace <page_id> with the values captured from Status page):

https://api.statuspage.io/v1/pages/<page_id>/incidents.json?api_key=

  1. Select Template under Format.
  2. Click Add New, to create a new template.
  3. Enter a template Name.
  4. Paste the below sample template:

{
"incident": {
"name": "test",
"status": "investigating",
"message": "EP webhook working"
}
}

  1. Click Save.
  2. Select the newly created template.
  3. Add an email address to On Failure Alert.
  4. Expand Request.
  5. Click Add API Request Headers.
  6. Add two request headers as
Key Value
accept application/Json
content type application/Json

Results
Data in Statuspage will look something like this.

image.png