Webhook
Connect Any Third-Party Platform with All Quiet via HTTP calls
Maximize your team’s efficiency with All Quiet’s outbound webhooks. Connect seamlessly with third-party platforms, enabling real-time alerts and maintaining operational awareness.
Create Outbound Integration
- Click on
Integrations > Outbound
to navigate to the outbound integrations page. - Once you’re on the Outbound Integrations page, click on
Create New Outbound Integration
in the top-right corner.
- Enter a name for your integration in the Display Name field, such as “My Outbound Webhook”.
- Select a team from the dropdown menu.
- In the Type section, choose Discord from the dropdown menu.
- After filling in all required details, click on the Create Integration button to finalize the setup.
After successfully creating your new outbound integration, you’ll be redirected to the details page automatically.
The option Triggers Only on Forwarded
is disabled by default. This means that we will forward all incidents to your Webhooks, unless excluded by additional routing rules. When enabled, we will not automatically send incidents to your Webhooks. Requests will only be sent if users manually forward specific incidents or if you set up routing rules for your Webhook Outbound integration that automatically forward incidents in specific scenarios. You can change your selection anytime.
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
- Select an incident from the ‘Latest Incidents’ section. This incident acts as a sample to define how the webhook should behave.
- 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.
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.
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
- 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.
- After confirming the request is accurate, save the mapping.
- Use the
Trigger Dummy Request
button to test the webhook, validating the end-to-end process. - The recorded request and response will be visible in the right pane under “Latest Requests”.