Mastering Outbound Webhooks: Enhance Your All Quiet Integration

Image

Published: Tuesday, 09 January 2024

🌐 Universal Connectivity: Uncover how to use outbound webhooks with All Quiet for integrating a wide range of third-party platforms via HTTP calls.

Efficient incident management is not an island - it requires seamless integration with the broader array of tools and platforms your team uses. With All Quiet’s outbound webhooks, you're equipped to create a cohesive alert ecosystem. This feature is engineered to connect with any third-party service that accepts HTTP requests, enabling a vast network of potential integrations.

In this detailed walkthrough, we’ll cover how you can leverage All Quiet to send alerts to any webhook-compatible platform, effectively enabling your team to maintain awareness across all operational fronts. From incident notification to real-time updates, learn how to configure All Quiet’s webhooks to fit into your existing toolchain.

Create Outbound Integration

  1. Click on Integrations -> Outbound to navigate to the Outbound Integrations page.
  2. On the Outbound Integrations page, click "Create New Outbound Integration" in the top-right corner.
Outbound Integrations
  1. Enter a name for your integration in the Display Name field, such as "My Outbound Webhook".
  2. Select a team from the dropdown menu.
  3. In the Type section, choose Webhook from the dropdown menu.
  4. After filling in all required details, click on the Create Integration button to finalize the setup.
Create Webhook Outbound Integration

Configure Webhook Request

To configure webhook requests in the All Quiet incident management tool, you would typically follow these steps:

  • Load an Incident: Choose an incident from your list to serve as a test case.
  • Write a Template: Craft a Handlebars template that converts the incident data into a webhook request payload.
  • Review & Dispatch: Examine the generated request for accuracy, then save and trigger a test request to confirm the integration works as expected.

Load Incident Model for Testing

  1. Select an incident from the 'Latest Incidents' section. This incident acts as a sample to define how the webhook should behave.
  2. Clicking on an incident will populate its JSON structure in the test area (2), allowing you to use real incident data to model the webhook request.
Load Incident Model for Testing

Write a Template

With the incident data loaded, navigate to the 'Template' section. Here, use Handlebars syntax to map the incident data fields to the corresponding webhook JSON structure. This template determines how the incident data is transformed into the format required by the receiving endpoint.

Write a Template

The following JSON structure provides a template for sending a webhook request. You can modify the method, url, headers values, and the body content to fit the specific requirements of your webhook integration.

For each new incident event, such as creation, resolution, or commenting, All Quiet will send an HTTP call with the specified method, headers, and body to the URL defined in the webhook request JSON.

            {
                "method": "POST",
                "url": "https://your-url.com",
                "headers": {
                    "Content-Type": "application/json; charset=utf-8",
                    "X-Your-Header": "abc"
                },
                "body": {
                    "text": "Your Text Content",
                    "formData": {
                        "key1": "a",
                        "key2": "b"
                    },
                    "json": {
                        "prop1": "a",
                        "prop2": {
                            "someArray": [{"k": "v"}]
                        }
                    }
                }
            }
            

Only one of text, formData, and json is used. If you specify more than one, the first one is used.

Inspect and Send Webhook Request

  1. In the 'Webhook Request' section, review the final payload based on your template. This is where you ensure that all necessary data is correctly formatted and included.
  2. After confirming the request is accurate, save the mapping.
  3. Use the 'Trigger Dummy Request' button to test the webhook, validating the end-to-end process.
  4. The recorded request and response will be visible in the right pane under "Latest Requests".
Inspect and Send Webhook Requestn

In summary, configuring webhooks in All Quiet involves a three-step technical process that is essential for efficient incident management. First, select a real incident as a test model to ensure practical relevance. Next, employ Handlebars templating to craft a precise webhook request structure that meets your specific integration needs. Finally, meticulously review and test the webhook payload to guarantee accurate data transmission. It's vital to monitor the "Latest Requests" section for a clear log of requests and responses, ensuring your webhook integrations are operational and effectively communicating with your chosen third-party platforms.

Read all blog posts and learn about what's happening at All Quiet.