Improve Clarity and Automation with Variables | All Quiet Payload Mapping Guide

[0:00:01] Hi there, I'm Peer from All Quiet. Sometimes the information that your monitoring tools provide is fragmented.

[0:00:06] This means you will have to combine information from several objects to give your teams context or to route incidents based on certain criteria. For this reason, we are providing "Variables" at All Quiet.

[0:00:19] Variables allow you to take information from several attributes and put them into one new field.

[0:00:24] Now, in order to demonstrate some of our variables' functionality, let's look at this example.

[0:00:31] The latest payload we received from our monitoring tool includes the "service_name" and an "error_code" in the JSON body.

[0:00:45] If we only map the "service_name" to the incident's "Title", the notification our engineers receive will simply be "Payment-Gateway", which is far too vague.

[0:00:57] We rather want something specific that combines "Payment-Gateway" with the type of error that was found. So in order to do this, we need the variables.

[0:01:04] But first, we need to map the JSON body objects against All Quiet attributes because for all attributes, All Quiet automatically creates a variable we can use in the mapping.

[0:01:22] For demonstration purposes, we've already added "Service Name" and "Error Code" to the incident mapping.

[0:01:27] Now, in the mapping pane, the order of your attributes matters. All Quiet processes these from top to bottom.

[0:01:34] For the "Title", to use variables from "Service Name" and "Error Code", you must place the "Title" below those two fields. You can easily drag and drop them to fix the order if necessary.

[0:01:55] Now to add the variables, we need to change the mapping for the "Title". From "JSONPath", we switch to "Static".

[0:02:02] And now we type in our variables by using double curly brackets. These variables, if they should refer to the current incident, will always start with "currentIncident" with a large "I" - this is important - "dot" and then the name of the attribute in your All Quiet incident.

[0:02:22] So for example here it's "Service Name". This part is not case sensitive. This is also important to mention: before and after the variable expression, there should be a space.

[0:02:40] Now we have the service name. What we want to add is "Error Code:" as text and then we want, of course, to extract the "Error Code" which follows the same logic.

[0:02:52] So it's "currentIncident" but not "Service Name", it's "Error Code", the name we've given our attribute. Save.

[0:02:59] And as you can see we extract the new title "Payment-Gateway Error Code: 504" which we can use for any future incidents.

[0:03:09] Now that we've showcased how you can extract information from different objects in the payload and merge them into one incident attribute using our variables, we will also show you how you can use variables to define your incident workflow logic.

[0:03:21] Imagine that you need to route alerts to different teams based on the region and the environment of the alert.

[0:03:28] Your tool sends these as two separate fields: the Region and the Environment. Now, just like for the "Title", you can map the information from both fields to a new custom attribute that we called "Routing Key".

[0:03:47] That extracts information from the region and from the environment. Again, make sure this custom attribute sits below both - region and environment - so you can use the variables.

[0:04:03] So if the payload says "EU" and "Production", this variable becomes "EU - Production", as you can also see in the incident preview below. You can now create a routing rule in All Quiet that looks specifically for "EU - Production" to ensure the right team gets the call.

[0:04:22] Now before we create the routing rule, make sure that we know which integration belongs to which team because routing rules always have to be created in the team where the incident is created.

[0:04:34] Now the webhook integration that we've created here is part of the "Root Team" as we can see in the "Edit" tab.

[0:04:47] Knowing this, we can now navigate to the Advanced Routings tab and click "+ Create". Add a new Advanced Routing called, for example, "Routing to Teams" and as the root team select the "Root Team" as I just explained.

[0:05:03] Now it's time to add the rule. As a "Condition" we want to make sure that we only look into incidents from the specific integration we just looked at - the "Webhook".

[0:05:10] Additionally, we want to add attribute conditions, and now we can use the value that we just saw from our variable mapping - the "Routing Key" - to route incidents based on certain values.

[0:05:27] So for example, if the attribute called "Routing Key", which we can select here, equals the value "EU - Production", we want to make sure that as an action the incident is assigned from the "Root Team" to the "Europe Production" team. Click save.

[0:05:53] Now to test our rule, we can go back to our inbound integration and the mapping tab and resend the payload that we used to set up our payload mapping.

[0:06:08] We look into the incident. We can see that the routing rule was successful and that the incident that was created in the "Root Team" was assigned to our "Europe Production" team based on the "Routing Key".

[0:06:20] Of course, if the "Routing Key" changes, you can add more routing rules to make sure that the incident is moved to the correct team based on the "Routing Key".

[0:06:35] All in all, our variables are a great way to turn scattered data not only into better communication, but also into automation.

[0:06:48] Thank you so much for watching. Make sure to check out the other videos on our YouTube channel and read our documentation under docs.allquiet.app. See you next time.