Radio Mast

Overview

This document provides a detailed guide to integrating Radio Mast with Callgoose SQIBS for real-time Incident Management, Incident Auto Remediation, Event-Driven Automation, and other automation purposes. The integration enables automatic creation, updating, and resolution of incidents in Callgoose SQIBS based on alerts triggered in Radio Mast. The guide includes steps for setting up alerts in Radio Mast, configuring webhook notifications, creating API filters in Callgoose SQIBS, and troubleshooting.

Prerequisites

• Radio Mast Account: Access to Radio Mast for creating alerts and managing notifications.
• Callgoose SQIBS Account: With valid privileges to set up API filters and receive notifications.
• Webhook/API Endpoint: Available in Callgoose SQIBS to receive alerts from Radio Mast.

1. Obtain API Token and Endpoint Details

To integrate with Callgoose SQIBS, you first need to obtain an API token and find the API endpoint details.

• Generate an API Token:
• Follow the guide on How to Create API Token in Callgoose SQIBS.
• Find the API Endpoint:
• Refer to the Callgoose SQIBS API Endpoint Documentation to get the endpoint details where the JSON payloads from Radio Mast will be sent.

2. Debugging and Troubleshooting

You can enable debugging in the API tokens used with Radio Mast notifications for troubleshooting purposes.

• Enable Debugging:
• You can update the debug value when adding or updating an API token.
• When API tracking is enabled, logs are stored in the API log section for your review. The debugging option will automatically disable after 48 hours.
• When API tracking is turned off, no logs are saved in the API log.
• Using API Log for Troubleshooting:
• The API log provides detailed information on all API calls made to Callgoose SQIBS.
• You can check the JSON values in each API log entry for troubleshooting purposes.
• Use the information in the API log to create or refine API filters to ensure incidents are created correctly based on the API payloads received.
• Callgoose SQIBS creates incidents according to your API filter configuration, giving you full control over how alerts from different services trigger incidents and alerts for your support team or automation processes.

3. Configuring Radio Mast to Send JSON Payloads

Follow these steps to set up monitoring, alerts, and webhook integrations in Radio Mast, ensuring that the JSON payloads generated match the required format for Callgoose SQIBS.

3.1 Setting Up Alert and Webhook in Radio Mast

• Log in to Radiomast
• Use your credentials to log in to the Radiomast platform.
• Add Your Radio Station
• If you haven’t added your radio station, add a radio station by click on Add.
• Set Up Alerting Contact
• From the Radiomast homepage, navigate to Alerting.
• Click on Add Alerting Contact and select Add Webhook.
• Enter a name for the contact in the provided field.
• In the Webhook URL field, paste the endpoint URL from Callgoose SQIBS.
• Note: The final API endpoint may vary based on authentication and other URL parameters. Find your final API endpoint here.
• Ensure the Alert me when any stream is down option is selected.
• Click Save Contact.
• Create a New Alert Policy
• Go back to the Alerting section and click on New Alert Policy.
• Configure the alert policy according to your requirements.
• Ensure you select the contact you created in the previous step.
• Click Save Alert Policy.
• Test the Alert Policy
• After saving, go back and open the alert policy and select Test Policy to send a test payload to Callgoose SQIBS.
• Go to the API Log section in Callgoose SQIBS to verify the test payload and ensure everything is functioning correctly.

3.2 Finalizing and Testing

• Validate the Integration:
• Trigger the alert condition manually if possible to verify that the correct JSON payload is sent to Callgoose SQIBS.
• Resolve the alert to ensure the resolved state payload is also correctly sent and processed.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

To correctly map incidents from the Radio Mast alerts, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from Radio Mast

Alert Triggered (type: "down")

json

{
  "timestamp": 1730086219,
  "summary": "NPO Radio1 Alert: radio1-bb-mp3 is down",
  "event": {
    "type": "down",
    "station": {
      "name": "NPO Radio1",
      "id": "d49cbbb2-89ba-4d1b-9b2e-bae4f839b984"
    },
    "stream": {
      "listening_url": "http://icecast.omroep.nl/radio1-bb-mp3",
      "name": "radio1-bb-mp3",
      "silence": 3,
      "id": "3c019e1c-c273-44fa-ac54-d609da2f406a"
    }
  }
}

Alert Resolved (type: "up")

json

{
  "timestamp": 1730086579,
  "summary": "NPO Radio1 Resolved: radio1-bb-mp3 is up",
  "event": {
    "type": "up",
    "station": {
      "name": "NPO Radio1",
      "id": "d49cbbb2-89ba-4d1b-9b2e-bae4f839b984"
    },
    "stream": {
      "listening_url": "http://icecast.omroep.nl/radio1-bb-mp3",
      "name": "radio1-bb-mp3",
      "silence": 0,
      "id": "3c019e1c-c273-44fa-ac54-d609da2f406a"
    }
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an Radio Mast integration template in the "Select Integration Template" dropdown in the API filter settings, you can use it to automatically add the necessary Trigger and Resolve filters along with other values. The values added by the template can be modified to customize the integration according to your requirements.

4.2.2 Manually Add/Edit the Filter

• Trigger Filter (For Creating Incidents):
• Payload JSON Key: "event"."type"
• Key Value Contains: [down]
• Map Incident With: "event"."stream"."id"
• This corresponds to the unique event.stream.id from the Radio Mast payload.
• Incident Title From: "event"."stream"."name"
• Incident Description From: Leave this empty unless you want to use a specific key-value from the JSON payload. If a key is entered, only the value for that key will be used as the Incident Description instead of the full JSON. By default, the Incident Description will include the full JSON values.
• Example: If you use the "summary" key in the Incident Description From field, the incident description will be the value of the "summary" key. In the example JSON payload provided earlier, this would result in a description like "NPO Radio1 Alert: radio1-bb-mp3 is down".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "event"."type"
• Key Value Contains: [up]
• Incident Mapped With: "event"."stream"."id"
• This ensures the incident tied to the specific event.stream.id is resolved when the alert status returns to normal.

Refer to the API Filter Instructions and FAQ for more details.

4.3 Finalizing Setup

• Save the API Filters:
• Ensure that the filters are correctly configured and saved in Callgoose SQIBS.
• Double-check that all key mappings, incident titles, and descriptions are correctly aligned with the payload structure sent by Radio Mast.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Radio Mast that causes an alert (e.g., when a stream goes offline).
• Verify that an incident is created in Callgoose SQIBS with the correct information.

5.2 Resolving Alerts

• Acknowledge and Resolve the Alert:
• Once the issue is resolved in Radio Mast (e.g., The stream is back online), verify that the incident in Callgoose SQIBS is automatically marked as resolved.

6. Security Considerations

• API Security: Ensure that the Callgoose SQIBS API endpoint is correctly configured and that the API token is securely stored and used.
• Radio Mast Permissions: Confirm that the webhook in Radio Mast has appropriate permissions to send alerts and data to Callgoose SQIBS.

7. Troubleshooting

• No Incident Created: If no incident is created, verify that the webhook URL in Radio Mast is correct and that the JSON payload structure matches the API filters configured in Callgoose SQIBS.
• Incident Not Resolved: Ensure that the resolve filter in Callgoose SQIBS is correctly configured and that the JSON payload sent by Radio Mast matches the expected structure.

8. Conclusion

This guide provides a comprehensive overview of how to integrate Radio Mast with Callgoose SQIBS for effective incident management. By following the steps outlined, you can ensure that alerts from Radio Mast are automatically reflected as incidents in Callgoose SQIBS, with proper resolution tracking when the issues are resolved.

For further customization or advanced use cases, refer to the official documentation for both Radio Mast and Callgoose SQIBS:

• Radio Mast Documentation
• Callgoose SQIBS API Token Documentation
• Callgoose SQIBS API Endpoint Documentation
• API Filter Instructions and FAQ
• How to Send API

This documentation will guide you through the integration process, ensuring that your incidents are managed effectively within Callgoose SQIBS based on real-time alerts from Radio Mast.