Documentation
📖Welcome to the All Quiet Documentation! Here, you will find comprehensive guidance on leveraging the powerful capabilities of All Quiet to tailor your incident management process to your specific requirements. Our documentation aims to provide you with a clear understanding of how to effectively configure and manage escalation tiers, schedules, and rotations.
We value your feedback, so if you come across any missing information or have suggestions to enhance our documentation, please don't hesitate to reach out to us at support@allquiet.app. Your input is highly appreciated as we continually strive to improve our documentation to meet your needs.
What is All Quiet?
All Quiet is an incident management platform with dedicated apps for both iOS and Android.
It is designed for teams which take operative responsibility for software systems. The apps allow team members to collaborate and respond to incidents in a convenient and dedicated channel.
Incidents are escalated either by automatic escalation when no team member is responding or by explicit escalation when a team member needs help from her colleagues.
Quickstart
To get going with All Quiet follow these steps:
- Sign up for an account. It's free for 30 days!
- Create a team and pick a name for it, e.g. "My Product Team".
- Invite your colleagues to your team so they can collaborate with you.
- Create an integration with your observability tool, e.g. AWS Amazon CloudWatch.
- The platform is collecting incidents through your integration and sending out incident notifications to your team's members now.
- Download the All Quiet app for your mobile phone. You 'll be notified about new incidents only through push notifications to the installed app to ensure a dedicated channel.
- You're now all set ✅. We hope for a very quiet time for your team! 😌
Teams
Teams are a means of organizing collaborators (team members) and integrations.
- Each user can be a member of multiple teams.
- Each integration belongs to exactly one team.
- Each incident triggered by an integration is thus available for collaboration only to the members of the integration's team.
Create a Team
Under Teams click Create Team. 
Pick a team's name and hit Create. You can later change the
team's name.
Members
Roles
A user can one of the following roles within a team:
- Member A member or collaborator can collaborate on all incidents.
- Adminstrator An admin can manage a team's members and integrations as well as collaborate on incidents.
Inviting Members
Once you've created your team you are automatically a member with role Administrator. You are also the billed user of that team. See 6. Billing
To add new members or admins to your team you need to invite your colleagues by email.
Your colleagues need to create an account and then accept the invitation. Otherwise they won't be able to participate in collaboration.
Step 1: Goto your team's members page
Step 2: Add multiple emails to be invited, then click Invite
to join.
We'll send emails to your
invites with instructions on how to accept your invitation.
Escalations, Schedules & Rotations
Managing escalation tiers, schedules, and rotations for a team should be a seamless and intuitive process. With All Quiet, you can effortlessly configure and manage these components through a sophisticated drag and drop user interface. This user-friendly interface allows you to easily define and adjust escalation tiers, schedules, and rotations, providing a clear overview of your team's configuration.
To access the escalation management page, simply click on the "Escalations" option.
Escalation Tiers
Escalation tiers allow incidents to be escalated to the next level when they are not acknowledged by the members of the current tier or when manual escalation is triggered.
Create a Tier
To create a new escalation tier in All Quiet, the process is straightforward. Simply drag and drop the team members into the designated drop area labeled "Drop members here to create a new tier." This action will automatically generate a new tier with a default schedule and rotation, ensuring a seamless setup for immediate use.
To add an additional escalation tier in All Quiet, follow these steps. Start by locating the second tier, which is currently inactive and awaiting configuration. Then, simply drag and drop a team member onto the drop area of the second tier. Once you drop the member onto the inactive tier, it will activate, creating a new escalation tier. This intuitive action allows you to easily expand the escalation hierarchy by adding more tiers as needed, ensuring a flexible and scalable setup for managing incidents effectively.
Automatic escalation
To edit the automatic escalations between two tiers, navigate to the configuration section specifically pertaining to the desired tiers. Within this section, locate and click on the corresponding label.
After clicking on the label, an input box will appear, enabling you to modify the automatic escalation behavior. To disable automatic escalation, simply leave the input box empty.
Schedules
Within the management of escalations, All Quiet allows you to define schedules for each escalation tier. These schedules determine the on-call periods for team members. With schedule customization, you can specify the time of day, such as 8:00 AM to 4:00 PM, and designate specific weekdays, such as Monday through Friday, for the schedule to be active. This flexibility enables precise control over when team members are available and responsible for incident response within each escalation tier.
To edit the on-call periods of a schedule, simply click on the label located at the top left of the schedule. By clicking on the label, you can access the edit dialogue where you can modify the schedule's settings. The label will display the current settings, which are set to "everyday" by default, indicating that no specific settings have been defined yet.
In the edit dialogue, you can specify the start time and end time for the schedule. Leaving the start or end fields empty will be interpreted as either "until" or "from" without a specific start or end time. Additionally, you can select the respective weekdays when the members of the schedule should be on-call by checking the corresponding checkboxes. This flexibility allows you to precisely define the time periods and weekdays for the on-call schedule according to your specific requirements.
After clicking "Save Schedule" in the edit dialogue, the schedule's settings will be saved, and you will immediately see the current schedule's settings displayed in natural language format at the top left corner. This provides a clear and easily understandable representation of the saved schedule settings, ensuring visibility and quick reference to the configured on-call periods and weekdays.
Rotations
Within All Quiet, managing rotations is accomplished through the use of rotation groups within each schedule. Rotation groups ensure fair distribution of on-call responsibilities among team members. For instance, you can create a schedule specifically for weekends, active only on Saturdays and Sundays, and set up four rotation groups based on this weekend schedule. Each rotation group would consist of team members who are on-call together. By adjusting the rotation settings to "weekly," each group would take turns being on-call for a weekend every four weeks. This approach effectively balances on-call duties and protects team members' weekends, allowing for equitable rotation scheduling within All Quiet.
To modify the rotation settings of a schedule, simply click on the right label associated with the schedule. By default, this label will display "no rotation." Clicking on it will open the rotation settings dialogue, allowing you to configure and customize the rotation settings according to your requirements.
To edit the rotation settings, you have the flexibility to choose the rotation period, such as "daily," "weekly," "biweekly," or "monthly." Additionally, you can specify the starting point of the rotations. For monthly rotations, you can select the exact date, such as the 1st of a month. In the case of other rotation options, you can choose the specific weekday. For example, if you select "weekly" and "Wednesday," each rotation will span one week from Wednesday until Tuesday midnight.
Once you click "Save Rotation," the rotation settings will be saved and displayed in the upper right label. It's important to note that if you specify rotation settings other than the default (no rotation), it is necessary to have more than one rotation configured. Otherwise, the specified settings will not have any effect.
Team Calendar
To view the calendar of a team and gain an overview of team members' on-call and off-call periods within each escalation tier, follow this step:
Access Team Calendar Page
Access the team calendar page: Navigate to the team management section or select the specific team from the menu. Look for the option labeled "Team Calendar".
View Team's Calendar and Schedules
On the team calendar page, you will find the schedule organized by team member and further divided by escalation tiers. This layout allows for easy comprehension of each team member's on-call and off-call periods. Additionally, you can also identify any individual overrides, such as vacations, that team members have specified. This comprehensive overview provides valuable insights into the team's availability and helps ensure smooth coordination and coverage during various shifts and incidents.
Personal Availability
This section in All Quiet's documentation focuses on the crucial aspect of managing personal availability, ultimately contributing to a calm and efficient working environment, ensuring smooth coordination and coverage for on-call responsibilities.
Your Availability
Within the main menu, you will find a link titled "Your Availability" which dynamically indicates your current on-call status by displaying a blinking red or green indicator. By clicking this link, you will be directed to the "Your Availability" page, where you can conveniently view all your upcoming on-call duties across various teams.
Personal Overrides
To create an individual override, such as a "fill-in" for a colleague on vacation or for your own vacation, you can add online or offline schedules with specified start and end dates. Creating these individual schedules is effortless within All Quiet. Simply click the "plus" button located in the header of the first column. A calendar will appear, allowing you to conveniently select the start date and end date. This intuitive process enables you to establish personalized overrides with fixed durations, ensuring accurate representation of your availability during specific periods.
Instead of manually clicking the plus button and explicitly setting the start and end dates, All Quiet provides a convenient alternative. You can effortlessly select the desired start and end dates from the calendar by simply clicking on the corresponding box in the first column for the start date (1), and subsequently clicking on the respective box for the end date (2). This streamlined approach ensures a user-friendly experience, allowing you to quickly and accurately define the duration of the individual override.
Example with a Vacation Schedule
The screenshot demonstrates an example of an individual vacation schedule (marked as "offline") spanning three consecutive days. However, it is worth noting that during this period, the user should have been on call, as indicated by the green schedules in the other columns. Additionally, you can observe that the online status changes to "offline" during this scheduled time off. To modify or remove an existing schedule, simply click on the respective schedule and make the necessary adjustments. This straightforward process allows for easy editing or deletion of individual schedules, ensuring accurate representation of availability within the system.
On-Call Reminder
Stay informed with our automatic on-call reminders. By default, you'll get an email one day prior to your shift to help you prepare. Prefer not to be reminded? No problem. Just deselect the reminder in your account settings.
Timezones
When it comes to managing schedules and rotations across different timezones, All Quiet simplifies the process to ensure a smooth experience. The reference timezone for all weekdays and time slots is based on the team's timezone. This means that regardless of individual team members' local time, the schedules and rotations will align with the team's designated timezone.
To adjust the team's timezone, you can easily modify it within the team's edit form. By default, the timezone is set to the one belonging to the user who created the team. However, you have the flexibility to update it according to the team's specific location or the desired timezone for coordination purposes. This feature allows for effective collaboration and ensures that everyone is on the same page, even when working across different timezones. All Quiet streamlines timezone management, making it straightforward to maintain accurate schedules and rotations for teams operating in various regions.
Alerting Channels
All Quiet keeps you informed through various alerting channels:
- Emails
- Push Notifications
- SMS
- Phone Calls
Incidents are categorized by their severity levels: "Critical," "Warning," or "Minor." The severity of an incident determines which channel(s) will be utilized to send alerts:
- Critical: Emails, Push Notifications, SMS, Phone Calls
- Warning: Emails, Push Notifications, SMS
- Minor: Emails, Push Notifications
You also have the option to override the 'Do Not Disturb' mode on Android devices and enable 'Critical Alerts' on iOS devices. These functionalities are only impactful for incidents labeled as "Critical."
SMS and Phone Calls
All Quiet offers the capability to keep you immediately informed through SMS and voice calls when incidents occur. Here's how to set this up for your user profile:
1. Navigating to 'Your Account':
Start by accessing your personal account settings. From the main dashboard, click on "Your Account".
2. Entering Your Phone Number:
In the 'Phone Number' field, input your number using the international format. For instance, you might enter: +12035479055.
3. Choosing Your Notification Preferences:
- For SMS Notifications: Toggle the 'Alert by SMS' switch to 'ON' if you wish to receive SMS updates on every incident change.
- For Phone Calls: Toggle the 'Alert by Phone Call' switch to 'ON' if you'd like All Quiet to call you.
Keep in mind the following for Phone Calls:
- Phone calls are triggered only once, at the moment an incident is opened.
- Calls are reserved for incidents marked with the severity level of "Critical".
- We'll always call you from our fixed number +1 2035479055
Critical Push Notifications
Critical Alerts on iOS Devices
To guarantee that you always receive notifications for pressing incidents, it's essential to set up push notifications and enable "Critical Alerts" on your iPhone. This part offers a detailed guide on how to do this, ensuring that All Quiet can alert you audibly and through vibrations, even when your phone is set to silent or "Do Not Disturb."
Critical Alerts will only be triggered when the incident's severity is "Critical".
Granting Push Notification Permissions
The initial screenshot displays the phase after logging in, where users are encouraged to authorize push notifications. Users also have the option to activate "Critical Alerts". Upon selecting this checkbox, the iOS system will prompt for the necessary permissions, as depicted in the subsequent screen.
Allowing 'Critical Alerts':
The screenshot depicts the operating system's request for permission to enable critical alerts.
Once the user has given permission for critical alerts, it becomes visible in the app's settings, as shown in this screenshot.
Please note that some Android devices may have slightly varied menus or terms depending on the manufacturer and version of the Android OS. Always refer to your device's user manual or official support channels if you're uncertain about any step.
'Do Not Disturb' on Android Devices
To ensure you never miss an urgent incident notification, it's vital to configure push notification permissions and override the "Do Not Disturb" mode on your Android device. This section provides step-by-step instructions on how to achieve this, so that even when your phone is in silent or "Do Not Disturb" mode, All Quiet will be able to notify you with sound and vibrations.
"Do Not Disturb" will only be overriden when the incident's severity is "Critical".
Granting Push Notification Permissions
The first screenshot shows the post-login onboarding phase. Users are prompted to grant push notification permissions, emphasizing the "Allow Notifications" button. This step ensures timely delivery of critical alerts.
Overriding 'Do Not Disturb' Mode:
In the subsequent screen, users are introduced to the option of overriding the "Do not disturb" (DnD) mode. Two toggles allow users to determine if sound and/or vibration should bypass the DnD settings. The "Override DnD in settings" button at the screen's bottom serves as a pointer to the next step.
Proceeding further, the third screenshot takes users to the All Quiet app's settings within the Android operating system. Here, the "Override Do Not Disturb" option awaits user interaction to grant the app permission to override system DnD settings.
Returning to the "Overriding 'Do Not Disturb' Mode" screen for the final step, a green success message now confirms the successful override of the DnD mode. This completion message indicates that All Quiet is now set to deliver critical alerts, even with the phone's DnD mode activated.
Please note that some Android devices may have slightly varied menus or terms depending on the manufacturer and version of the Android OS. Always refer to your device's user manual or official support channels if you're uncertain about any step.
Inbound Integrations
Inbound Integrations are the heart of All Quiet, connecting your observability tools to our platform. Integrations are dynamic and flexible. The integration process is simple and involves two steps:
- Receving a payload
- Mapping payload attributes to incidents
How Integrations Work
To create a new integration, simply navigate to the Integrations tab and click on the Create New Integration button.
From there, give your integration a name, such as "AWS Amazon CloudWatch" if you're connecting to this tool. You'll also need to choose which team the integration should belong to, as this can't be changed later. Finally, select the type of integration, such as "AWS Amazon CloudWatch". Keep in mind that the integration type can't be changed later.
We offer concise and quick introductions that guide you through seamlessly integrating your observability tool in less than 5 minutes:
Configuring Integrations
Again, integrations work by a two-step process:
- Receving a payload
- Mapping payload attributes to incidents
Step 2 is identical for each integration type, while step 1 (receiving the payload) differs for each integration type.
We'll walk you through these steps by the example of a Webhook Integration.
Receiving Payloads
Once you've created an integration of type Webhook, you can send HTTP requests to the integration's URL.
Every request sent to this address will show up as a new payload from which we'll extract attributes and map these to incidents.
You can see payloads that were received by All Quiet in the right pane and select them as a template / example for your attribute mapping.
The payload will always be in JSON format and wrap other formats like HTML or XML depending on your payload.
formBody.
curl -X POST https://allquiet.app/api/webhook/8fa1637f-cafa-4a5d-8bb8-af1dd5caaf2f
-H "Content-Type: application/x-www-form-urlencoded"
-d "alertName=My+Monitor&alertStatus=Failed&description=From+cURL"
Mapping Payloads
To map a payload's JSON to an actual incident you need to define a set of mapping rules. Those rules are also defined in JSON. To allow you to conveniently configure your mapping your changes to the JSON are automatically applied to a preview of an incident.
How does attribute mapping work?
With attribute mapping you can map the payload of your integration to the defined data structure of All Quiet's incidents.
For each attribute in attributes we will evaluate all mappings from
the first to the last element. The result of a mapping will be
passed on to the next mapping element as an input. The last result will be the attribute's value. In the
following example the attribute Status is first mapped by a jsonPath and then by a
map evaluation.
Let's assume, we've created an integration of tpye Webhook. We can use the following CURL command below as an example to trigger the webhook:
curl -X POST 'https://allquiet.app/api/webhook/8fa1637f-cafa-4a5d-8bb8-af1dd5caaf2f' \
-H 'Content-Type: application/json' \
-d '{"alertName": "My Monitor", "alertStatus": "Failed", "description": "From cURL"}'
Then, we can map the payload to an incident with this attribute mapping:
{
"attributes": [
{
"name": "Status",
"mappings": [
{
"jsonPath": "$.jsonBody.alertStatus"
},
{
"map": "Failed->Open,->Resolved"
}
]
},
{
"name": "Title",
"mappings": [
{
"jsonPath": "$.jsonBody.alertName"
}
]
},
{
"name": "Severity",
"mappings": [
{
"static": "Critical"
}
]
},
{
"name": "Description",
"mappings": [
{
"jsonPath": "$.jsonBody.description"
}
]
}
]
}
Reserved and required attributes
| Attribute Name | Required | Allowed Values |
|---|---|---|
CorrelationId
|
Optional | Use this attribute to uniquely identify and correlate your incidents. If ommited, a hash of all attributes is used to uniquely identify the incident. |
Status
|
Required |
Open, Resolved
|
Severity
|
Required |
Minor, Warning, Critical
|
Title
|
Optional | Defaults to your integration's name |
Evaluation types
attribute must hold exactly one of the following evaluation types:
jsonPath
|
A JSONPath expression to map JSON (goessner.net/articles/JsonPath) |
xPath |
A XPath expression to map HTML or XML. ( w3schools.com) |
regex |
A regular expression to extract parts of text. The regex is evaluated with the .NET/C# flavor. If groups are matched, the named group "result" is returned. If no group is named "result" the last group is returned. If no groups are found the whole match is returned. ( regex101.com) |
map |
A simple map expression mapping values from A to B. The expression
A->1,B->2,->3 will map the value "A" to "1" and "B" to "2" and
fallback to
"3" if no match is found. You can also omit the fallback. The result will then evaluate to
the
original value.
|
static |
A static string. The result will always be this string. |
JSONPath examples
Extract elements by property
To get the value of the "Return-Path" field of the "headers" array, use
$.headers[?(@.field=='Return-Path')].value for the
following JSON:
{ "headers": [{ "field": "Return-Path", "value": "" }] } XPath examples
Extract elements by preceding tag value
To get the value of the "Server" field, i.e. the value of thetd that follows a
td with value "Server" use
//table/tr[td='Server']/td[2] for the following HTML:
<body>
<table>
<tr>
<td>Severity</td>
<td>Critical</td>
</tr>
<tr>
<td>Server</td>
<td>prod1</td>
</tr>
</table>
</body>
Regex examples
Extract value after colon
To get the value "my-server" after a colon followed by space use[: ](?[^: ]*)$
for the following text:
Any label here: my-server
Extract value after specific label
To get the value "my-server" after a label e.g. "SPECIFIC label here: " use(SPECIFIC label here: )(.*) for the following text:
SPECIFIC label here: my-server
Extract value before colon
To get the value "ERROR" before a colon use^[^:]* for the following
text:
ERROR: your-check on your-project on server app-1
Built-In Integrations
Generic Webhooks
How to connect: Generic Webhooks
Emails
How to connect: Emails
Datadog
How to connect: Datadog
AWS Amazon CloudWatch
How to connect: AWS Amazon CloudWatch
Microsoft Azure Monitor
How to connect: Microsoft Azure Monitor
Google Cloud Monitoring
How to connect: Google Cloud Monitoring
Prometheus
How to connect: Prometheus Alertmanager
Grafana
How to connect: Grafana
UptimeRobot
How to connect: UptimeRobot
New Relic
How to connect: New Relic
Site24x7
How to connect: Site24x7
all other platforms
Your observability tool is not listed? No problem, you can still integrate it with All Quiet and our generic integrations:
- Webhook
Learn more about our generic integrations in the next section Configuring Integrations.
Outbound Integrations
At the core of All Quiet's robust incident management system lies the versatility of our outbound integrations. Designed to bridge the communication gap, these integrations ensure that third-party tools are consistently notified of incidents and their corresponding interactions occurring within the All Quiet platform. This not only facilitates a smoother workflow but also enhances the efficiency of response mechanisms.
Recognizing the ever-evolving needs of the tech ecosystem, we're committed to continually expanding our integration repertoire. As time progresses, users can anticipate a richer array of integrations, aiming to cater to a broader spectrum of tools and platforms. Stay tuned as we amplify your incident management experience.
Built-In Integrations
Slack
How to connect: Slack
Incident collaboration
In this documentation we'll walk you through the web app. The web app has the very same behaviour as the iOS or Android app.
Open Incidents to see all incidents of your teams. The incidents are sorted by status and date. In this example you see no open incidents and some resolved incidents.
Resolving
To resolve an open incident click the green resolve button. This will notify all colleagues of the current escalation tier that the incident was resolved.
Escalating
In case you've investigated an incident and you need help from your colleagues you can escalate the incident to the next escalation tier by clicking the red escalate button. This will notify all colleagues of the current escalation tiers as well as the following escalation tier.
Commenting, Investigating & Reopening
Investigating open incidents
In case you've been notified of an open incident and you can tell you're team that you're looking into the incident by clicking the blue investigate button. This will notify all colleagues of the current escalation tiers that you're investigating the issue.
Commenting incidents
You can comment on an incident anytime by clicking the grey comment action button.
Reopening incidents
Sometimes you need to re-open an incident that is already marked as resolved. You can simply do this by clicking the red reopen button on a resolved incident.
SSO & OpenID Connect
All Quiet provides a secure and efficient way to integrate Single Sign-On (SSO) using OpenID Connect, offering a seamless authentication experience for your users. This integration allows your organization to utilize its existing identity provider (IdP) services to manage user access to All Quiet.
Step-by-Step Guide
Prerequisites
- Access to your organization’s identity provider (IdP) that supports OpenID Connect.
1. Contact All Quiet Support:
Begin by reaching out to our support team at support@allquiet.app. Provide details about your organization and the identity provider you are using. Our team will assist you with the initial setup process and provide necessary guidance.
2. Setting up in Your IdP:
In your identity provider’s management console, you will need to register All Quiet as a new application.
For the integration, you will need to provide the Client ID, Client Secret, and the Authority URL from your IdP. The Authority URL is usually the client-specific domain derived from the discovery document URL. These details are essential for establishing a secure and reliable connection between your IdP and All Quiet.
Additionally, you'll need to configure the Redirect URI in your IdP to https://allquiet.app/signin-oidc.
It's important to share Client ID, Client Secret, and the Authority URL over a secure channel with us to protect your sensitive information. One recommended way is through services like Yopass. All Quiet stores all secrets strongly encrypted in our database to ensure the safety of your credentials.
3. Verification and Testing:
Once the setup is completed, our team at All Quiet will perform a series of tests to verify the integration. This ensures that authentication requests are properly handled and user identities are correctly established through your IdP.
4. Finalizing the Integration:
After successful verification, the integration is considered complete. Your users can now sign in to All Quiet using their existing organizational credentials managed by your IdP.
Note on Support and Maintenance:
While All Quiet aims to make the integration process as straightforward as possible, we do not offer a self-service option for this setup. Our support team is dedicated to assisting you through each step of the process and ensuring the integration meets your organization's specific needs.
Conclusion:
Integrating your organization's SSO using OpenID Connect with All Quiet enhances your platform's security and user experience. With this setup, you ensure a consistent and secure access management system, aligned with your organizational policies and requirements.
Billing
All Quiet offers a 30 days trial. After 30 days you need to subscribe to our services to continue using our services effectively.
You can subscribe in the billing section of your dashboard.
We are using the leading payment processor Stripe to process your subscription and we'll never save your payment details on our side.
- ✅ No risk: you can cancel any time.
- ✅ You're flexible: change users any time.
- ✅ Control your costs: billed monthly.
- Rock-solid availability : Our app is always on, so you can be too!
Invoices
Your invoices will be available for download in the billing section of your dashboard.
Integrations
How All Quiet compares to alternatives
All
Quiet - Incident Escalation Made Easy.
© 2023 All Quiet GmbH. All rights reserved.