SwaggerHub

Overview

This document provides a detailed guide to integrating SwaggerHub 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 or events triggered in SwaggerHub. The guide includes steps for setting up webhook notifications in SwaggerHub, configuring API filters in Callgoose SQIBS, and troubleshooting.

Prerequisites

• SwaggerHub Account: Access to SwaggerHub for managing APIs and setting up 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 SwaggerHub.

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: How to Create API Token.
• Find the API Endpoint:
• Refer to the Callgoose SQIBS API Endpoint Documentation to get the endpoint details where the JSON payloads from SwaggerHub will be sent: API Endpoint Details.

2. Debugging and Troubleshooting

You can enable debugging in the API tokens used with SwaggerHub 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 SwaggerHub to Send JSON Payloads

To configure SwaggerHub to send JSON payloads according to Callgoose SQIBS requirements, follow these updated steps. This guide will help you set up a webhook notification within SwaggerHub to ensure that the JSON payloads meet the expected format.

3.1 Creating an API in SwaggerHub

To begin, you will first need to create an API within SwaggerHub.

• Log in to SwaggerHub:
• Access the SwaggerHub platform using your account credentials.
• Create a New API:
• On the Home page, click on Create API.
• Fill in the following details:
• Owner: Choose the owner of the API.
• Specification: Select the API specification (e.g., OpenAPI 3.0).
• Template: If you want to start without a template, choose None.
• Name: Enter a name for your API.
• Visibility: Choose either Public or Private based on your preference.
• After filling in the details, click Create API.

3.2 Setting Up Webhook Notifications

To ensure that the JSON payloads sent by SwaggerHub match those expected by Callgoose SQIBS, you must configure a webhook.

• Navigate to the Integration Settings:
• Click on the name of your API to open its detailed settings.
• Go to the Integration tab.
• Add a New Integration:
• Click on Add New Integration.
• From the available options, choose Webhook and click Add.
• Configure the Webhook:
• Integration Name: Type a name for the webhook (e.g., Callgoose SQIBS Webhook).
• Payload URL: In the Payload URL field, provide the API endpoint from Callgoose SQIBS.
• Note: Refer to the Callgoose SQIBS API endpoint documentation to determine the exact format for the URL.
• Lifecycle Events: Select the lifecycle events (e.g., API created, API updated) that will trigger the webhook.
• Finalize the Integration:
• After setting the name, payload URL, and selecting the lifecycle events, click Create to save the webhook.

3.3 Finalizing and Testing

• Validate the Integration:
• Trigger the webhook manually if possible to verify that the correct JSON payload is sent to Callgoose SQIBS.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

To correctly map incidents from the SwaggerHub notifications, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from SwaggerHub

Alert Triggered (action: "saved")

json

{
  "path": "/apis/Test23772/SimpleApi/1.0.0",
  "action": "after_api_version_saved",
  "definition": {
    "openapi": "3.0.0",
    "servers": [
      {
        "url": "https://virtserver.swaggerhub.com/Test23772/SimpleApi/1.0.0"
      }
    ],
    "info": {
      "title": "Simple Inventory API",
      "version": "1.0.0"
    },
    "paths": {
      "/inventory": {
        "get": {
          "summary": "searches inventory",
          "parameters": [
            {
              "in": "query",
              "name": "searchString",
              "schema": {
                "type": "string"
              }
            },
            {
              "in": "query",
              "name": "skip",
              "schema": {
                "type": "integer"
              }
            },
            {
              "in": "query",
              "name": "limit",
              "schema": {
                "type": "integer"
              }
            }
          ],
          "responses": {
            "200": {
              "content": {
                "application/json": {
                  "schema": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/InventoryItem"
                    }
                  }
                }
              }
            },
            "400": {
              "description": "bad input parameter"
            }
          }
        },
        "post": {
          "summary": "adds an inventory item",
          "requestBody": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryItem"
                }
              }
            }
          },
          "responses": {
            "201": {
              "description": "item created"
            },
            "400": {
              "description": "invalid input"
            }
          }
        }
      }
    },
    "components": {
      "schemas": {
        "InventoryItem": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "releaseDate": {
              "type": "string"
            },
            "manufacturer": {
              "$ref": "#/components/schemas/Manufacturer"
            }
          }
        },
        "Manufacturer": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a SwaggerHub 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: "action"
• Key Value Contains: [saved]
• Map Incident With: null
• Incident Title From: "definition"."info"."title"
• This will use the event title as the incident title in Callgoose SQIBS.
• 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 "action" key in the Incident Description From field, the incident description will be the value of the "action" key. In the example JSON payload provided earlier, this would result in a description like "after_api_version_saved".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: null
• Key Value Contains: null
• Incident Mapped With: null

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

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 SwaggerHub.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate an API Event:
• Trigger a condition in SwaggerHub that causes an event, such as an saving an API.
• Verify that an incident is created in Callgoose SQIBS with the correct title, description, and severity level as defined in your API filter settings.
• Validate Incident Creation:
• Check the Callgoose SQIBS dashboard to ensure that the incident has been created as expected, with all the appropriate details populated according to the JSON payload received from SwaggerHub.

6. Security Considerations

• API Security: Ensure that the Callgoose SQIBS API endpoint is correctly configured, and the API token is securely stored and used to prevent unauthorized access.
• Access Controls: Implement role-based access controls in both SwaggerHub and Callgoose SQIBS to restrict who can create, modify, and trigger webhooks and API filters.

7. Troubleshooting

• No Incident Created: If no incident is created in Callgoose SQIBS, verify that the webhook URL in SwaggerHub is correct and that the JSON payload structure matches the API filters configured in Callgoose SQIBS.
• Incorrect Incident Data: Ensure that the API filters in Callgoose SQIBS are configured correctly to parse and map the JSON payload fields from SwaggerHub accurately.
• Incident Not Resolved: If incidents are not being resolved as expected, check that the resolve filter in Callgoose SQIBS is correctly set up to match the resolution status sent by SwaggerHub.

8. Conclusion

This guide provides a comprehensive overview of how to integrate SwaggerHub with Callgoose SQIBS for effective incident management. By following the steps outlined, you can ensure that alerts and events from SwaggerHub 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 SwaggerHub and Callgoose SQIBS:

• SwaggerHub 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 events and alerts from SwaggerHub.