- \r\n
- Introduction\u00a0and relevance of this Integration<\/li>\r\n
- Steps of Setup\u00a0<\/li>\r\n
- Execution Flow Diagram\u00a0<\/li>\r\n
- ServiceNow Setup Part\u00a0<\/li>\r\n
- Azure Logic App Creation Part
A. Using ServiceNow Connector (Method 1)
B. Using HTTP Connector (Method 2)
C. Alert Action Group Creation\u00a0<\/li>\r\n - Testing and Validation\u00a0of Setup<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
<\/p>\r\n\r\n\r\n\r\n
- \r\n
- Introduction and relevance of this Integration<\/strong><\/span> –<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
In this article, we\u2019ll be going through the step by step instructions to integrate Azure Alerts and ServiceNow with the help of Azure Logic App.<\/p>\r\n\r\n\r\n\r\n
But why do we actually need to integrate any ITSM tool (like ServiceNow) with an Alerting system (like Azure Alerts)? Let’s discuss this below, by highlighting some advantages\u00a0–<\/p>\r\n\r\n\r\n\r\n
- \r\n
- When each deteriorated system condition is recorded, managed and maintained through a ticket, then this may increase accountability and answerability<\/em>.<\/em><\/strong><\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- \r\n
- Monitoring of Application or Infrastructure is a crucial aspect during Application Operations which can ultimately lead to improvement scopes for both Infrastructure and Application itself. ITSM tools (like ServiceNow) when integrated with any monitoring system (like azure alert) to automatically respond with Incident\/Ticket when an issue is captured by Azure Alerts, will optimize the flow of Infra\/Application improvement. These new tickets can be included (linked) with the ongoing Topics, Sprint Cycles, or new releases.\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- \r\n
- This makes the RCA Tracking process more fluent for each captured Issue, as we have a better view of ongoing issue trends and respective RCAs. This time tracking of RCAs is more precise.<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
When we integrate ServiceNow with Azure Alert, it will automatically <\/em><\/strong>generate a ServiceNow Incident whenever an alert is fired(due to failed system conditions) in Azure.\u00a0<\/p>\r\n\r\n\r\n\r\n
2. Steps of ServiceNow and Azure Alert Integration Setup<\/span> –<\/strong><\/p>\r\n\r\n\r\n\r\n
Now coming to the steps for this Integration Setup, we divide the setup into two Parts –\u00a0<\/p>\r\n\r\n\r\n\r\n
- \r\n
- ServiceNow Setup Part – In this part, we will use a developer Instance of ServiceNow, to find ServiceNow API Endpoints, Header content, Request Body etc and use these details in our Azure Logic App.\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- \r\n
- Azure LogicApp Creation Part – In this part, we will create our code logic (using LogicApp Designer) to integrate ServiceNow and call ServiceNow API through Logic App Connectors. We will discuss two different types of LogicApp connectors which can be used alternatively to Integrate Azure Alerts with ServiceNow.\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- \r\n
- Execution Flow Diagram<\/span>\u00a0<\/strong>–<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
This flow diagram helps us to understand about the Automation Flow that we have to create for this Integration Setup.<\/p>\r\n\r\n\r\n\r\n
![\"\"](\"https:\/\/opstree.com\/blog\/\/wp-content\/uploads\/2021\/05\/snow-automation-flow.png?w=780\")
<\/figure>\r\n\r\n\r\n\r\n- \r\n
- ServiceNow Setup Part<\/span>\u00a0<\/strong>–<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
ServiceNow is a cloud-based ITSM platform that covers incident management, problem management, change management, release management, and request management. ServiceNow has different types of tables(for example Incident table, Change table etc) to store respective ticket information, which can be modified through REST API Calls. In our below example we are using a REST API call to ServiceNow to Create Incident i.e. adding rows in the Incident Table of ServiceNow.\u00a0<\/p>\r\n\r\n\r\n\r\n
For Demo purpose, we will use Developer Instance of ServiceNow to fetch API Call information, as your company\/client\u2019s ServiceNow instance may have restricted access to explore the \u201cExplore API\u201d feature. Let’s get started by registering a developer ServiceNow Instance and create a Sample Incident through manual calling the API. [Below Demo is to know better about the working of ServiceNow APIs. You may skip this part and jump directly to Azure Logic App Creation part as well].<\/p>\r\n\r\n\r\n\r\n
- \r\n
- Setup developer instance on ServiceNow –\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
Go to – https:\/\/developer.servicenow.com<\/a> and sign-up to get started.<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
- \r\n
- After successful login, ‘Request’ a ServiceNow Instance (it’s good to select same location of instance as your client\u2019s\/company\u2019s ServiceNow Instance location). Note the credentials of your requested instance.\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- \r\n
- Login to your developer Instance with the credentials generated in the previous step.<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
- \r\n
- From the left-hand search bar, search and select the “REST API Explorer\u201d blade. Select your namespace as \u201cNOW\u201d, and \u201ctable API\u201d to get started. On this page we can find – GET, POST, PUT, DELETE API request syntax to modify table contents. Choose \u201cPOST\u201d request to create a record in the table. Now choose Table Name as \u201cIncident\u201d<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
NOTE: Copy-Paste the highlighted URL and save it aside, we require this API endpoint to automate the integration from Azure Logic App.<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
- \r\n
- Identify the \u201cRequest Headers\u201d (and note these aside). Optionally we can Input relevant \u201cIncident fields information\u201d in the \u201cResponse body\u201d space shown below by checking any sample incidents present on the instance, we can also leave it empty. Now CLICK on \u201cSend\u201d to trigger the API Call and create the incident.\u00a0\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
This will show a 201 response for that API Call, and the response body will display the Incident Number of the newly created Incident.\u00a0<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
We can verify the incident creation by searching this Incident Number on Incident Dashboard as shown below.<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
This is the manual way of triggering the ServiceNow API. Now, in the next part, we have to incorporate this API calling in our Azure Logic App.<\/p>\r\n\r\n\r\n\r\n
Note: For Company\/Client\u2019s ServiceNow account we need a service account of the ServiceNow Instance. Domain-based or SSO based logins won’t work. The Service Account will directly talk to the API and update the tables of your Client\u2019s ServiceNow Instance.<\/p>\r\n\r\n\r\n\r\n
5. Logic App Part<\/span>\u00a0<\/strong>–<\/p>\r\n\r\n\r\n\r\n
Azure Logic App is a PaaS based service that is used to create Automated workflows and Integrations. We will use Azure Logic App to integrate with ServiceNow. The code logic is also present on the Logic App. Logic App gives two ways to write the logic for our workflows – Logic App Designer with UI and JSON scripting. For the sake of simplicity, we will use UI based Logic App Designer in our Demo below.\u00a0<\/p>\r\n\r\n\r\n\r\n
- \r\n
- Create an Azure Logic app which will have our code logic and which will communicate with specified ServiceNow Instance and triggers ServiceNow API. (as shown below)<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
- \r\n
- From the \u201cLogic App Designer\u201d blade. Select any of these Action modules – \u201cHTTP request received Trigger \/ Azure Monitor Trigger\u201d\u00a0<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
In our example, we will see two separate methods of API Calling to ServiceNow Instance, with two different Azure Logic App connectors –\u00a0<\/p>\r\n\r\n\r\n\r\n
A. With ServiceNow connector<\/span> (1st Method)<\/p>\r\n\r\n\r\n\r\n
Add ServiceNow connector Action below HTTP Trigger Action. (as shown below)
<\/p>\r\n\r\n\r\n\r\n
In the connection Pop-up, fill Connection details such as –\u00a0<\/p>\r\n\r\n\r\n\r\n
Connection Name<\/strong> – Your choice of name for this connection setting<\/p>\r\n\r\n\r\n\r\n
Instance Name<\/strong> – URL of your ServiceNow instance\u00a0<\/p>\r\n\r\n\r\n\r\n
Username <\/strong>– Username of your ServiceNow Service Account or ServiceNow Developer Instance<\/p>\r\n\r\n\r\n\r\n
Password <\/strong>– Password of your ServiceNow Service Account or ServiceNow Developer Instance<\/p>\r\n\r\n\r\n\r\n
Hit on Create, this automatically validates the connection and use this setting.<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
After creating the connection, this connection is set to be used (as seen in the below image). This connector will hit the ServiceNow API with a POST request in the background. We just have to select the respective table to put the record information. In our case, we need to create an Incident so we use the Incident table.<\/p>\r\n\r\n\r\n\r\n
Also, we get the option of \u201cAdd Parameter\u201d, and from the pop-up box, we can select the options which are used as fields of the Incident such as Assigned_To, Assignment_Group, Location, Email etc.\u00a0<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
This is UI based selection of Incident Fields, as shown in below example – \u201cCategory\u201d field is selected with the value \u201cSample Application Name\u201d<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
NOTE:\u00a0<\/p>\r\n\r\n\r\n\r\n
Similar to this UI based field selection for ServiceNow Incident, we can also alternatively use code view to add ServiceNow Incident Fields. For this – Go to the \u201cCode View\u201d of your Logic App Designer > then find the block named \u201cbody\u201d under your \u201cServiceNow connector name\u201d and add the fields(in JSON syntax) which are present in your Sample Incident. The advantage of using \u201cCode view\u201d to add \u201cfield parameters\u201d is that sometimes the required Incident fields are not present in the \u201cAdd Parameters\u201d drop-down menu. So, we can define custom fields as per our ServiceNow Instance Incidents by adding those in JSON format of \u201cCode view\u201d.<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
<\/p>\r\n\r\n\r\n\r\n
B. With HTTP Connector<\/span> (2nd Method)<\/p>\r\n\r\n\r\n\r\n
Add HTTP connector Action below HTTP Trigger Action. (as shown in below image)<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
Now fill required details as below –\u00a0<\/p>\r\n\r\n\r\n\r\n
- \r\n
- Select Request Method – which has to be \u201cPOST\u201d as we want to create\/add a new record in the Table(i.e. Creating a ServiceNow Incident)<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- \r\n
- Mention URL of your ServiceNow Instance –\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
In this format create your URL “https:\/\/{MY-CLIENT-NAME}.service-now.com\/api\/now\/table\/incident”.<\/p>\r\n\r\n\r\n\r\n
- \r\n
- For Headers – you can write\u00a0
Accept – application\/json
Content-Type – application\/json<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\nNOTE: If the default information(such as API Endpoint, Headers Info etc) for the ServiceNow API mentioned above is not working for you, then you have to find the information by following the steps mentioned in the \u201cServiceNow Activity Part\u201d provided in the starting of this article.<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
For the \u201cRequest Body\u201d of this POST HTTP request, we can mention all the fields of the ServiceNow Incident in a JSON formatted way. As placed in the screenshot below.<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
For Authentication, there are multiple options provided in this HTTP connector.\u00a0<\/p>\r\n\r\n\r\n\r\n
In our case, we use \u201cBasic Authentication\u201d and mention the username and password of our ServiceNow Service Account or Developer ServiceNow Instance(if using developer instance)<\/p>\r\n\r\n\r\n\r\n
NOTE: In this example, we are providing credential details in \u201cPlain-Text\u201d. For using Keyvault secrets to be used in Logic Apps, follow this upcoming Blog.<\/p>\r\n\r\n\r\n\r\n<\/figure>\r\n\r\n\r\n\r\n
<\/p>\r\n\r\n\r\n\r\n
C. Create Action Group<\/span> (which will be used to test and validate this integration setup)<\/p>\r\n\r\n\r\n\r\n
We have created our Azure Logic App, now to trigger this Logic App from Azure Alerts we need to link this Logic App with an Action Group. For this create an Action Group as shown below.<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
Remember to enable common Alert Schema, by which you will get common Json Payload<\/em><\/strong> of the Alert Information in your Azure Logic App for any type of Azure Alert (either Metric Alert, Log Alert or Activity Log Alert)\u00a0<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
<\/p>\r\n\r\n\r\n\r\n
<\/p>\r\n\r\n\r\n\r\n
6. Test and Validate<\/span><\/strong>\u00a0–<\/p>\r\n\r\n\r\n\r\n
We have created the Logic App, linked the logic app with an Action Group, now it’s time to generate a dummy alert and validate if it is creating a ServiceNow Incident.\u00a0<\/p>\r\n\r\n\r\n\r\n
For testing purposes, we will create a dummy alert on a sample resource like a storage account and make such alert signal conditions that the alert will be fired and hence the action group is triggered which ultimately triggers the Logic App and creates a ServiceNow Incident.\u00a0<\/p>\r\n\r\n\r\n\r\n
- \r\n
- Create a storage account for testing this Integration Setup.<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
- \r\n
- Now create Dummy Alert on this storage account.<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
Here, using Used Capacity as a signal condition\u00a0<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
Create the alert condition in such a way that it will fire the alert on the first check, and the Logic App will be triggered without much waiting. (as shown below).<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
Select the same Action Group which you have created in part 5C of this article.<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
- \r\n
- Check Alert and respective Incident –\u00a0<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
- \r\n
- Wait for the alert to fire on Azure Portal\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
- \r\n
- After the alert is fired, check if the Azure Logic App is triggered<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
Find the Incident Number from the \u201cLogic App Run\u201d<\/p>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
- \r\n
- Find the Incident number on ServiceNow Instance and validate if the Incident has been created.\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
<\/figure>\r\n\r\n\r\n\r\n
Voila ..<\/p>\r\n\r\n\r\n\r\nAzure Logic Apps provides a convenient solution to many integration requirements (like this ServiceNow Integration setup). With Azure Logic Apps we can create ad-hoc automation tasks, serverless code logics, 3rd Party integrations making its usage scope quite vast.<\/p>\r\n\r\n\r\n\r\n
<\/p>\r\n\r\n\r\n\r\n
Blog Pundit:<\/strong> Adeel Ahmad<\/strong><\/a> & Sanjeev Pandey<\/strong>\u00a0<\/strong><\/strong><\/p>\r\n\r\n\r\n\r\n
Opstree is an End to End DevOps solution provider<\/p>\r\n\r\n\r\n\r\n
- Find the Incident number on ServiceNow Instance and validate if the Incident has been created.\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- After the alert is fired, check if the Azure Logic App is triggered<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- Wait for the alert to fire on Azure Portal\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- Check Alert and respective Incident –\u00a0<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
- Now create Dummy Alert on this storage account.<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
- Create a storage account for testing this Integration Setup.<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
- For Headers – you can write\u00a0
- Mention URL of your ServiceNow Instance –\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- Select Request Method – which has to be \u201cPOST\u201d as we want to create\/add a new record in the Table(i.e. Creating a ServiceNow Incident)<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- From the \u201cLogic App Designer\u201d blade. Select any of these Action modules – \u201cHTTP request received Trigger \/ Azure Monitor Trigger\u201d\u00a0<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
- Create an Azure Logic app which will have our code logic and which will communicate with specified ServiceNow Instance and triggers ServiceNow API. (as shown below)<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
- Identify the \u201cRequest Headers\u201d (and note these aside). Optionally we can Input relevant \u201cIncident fields information\u201d in the \u201cResponse body\u201d space shown below by checking any sample incidents present on the instance, we can also leave it empty. Now CLICK on \u201cSend\u201d to trigger the API Call and create the incident.\u00a0\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- From the left-hand search bar, search and select the “REST API Explorer\u201d blade. Select your namespace as \u201cNOW\u201d, and \u201ctable API\u201d to get started. On this page we can find – GET, POST, PUT, DELETE API request syntax to modify table contents. Choose \u201cPOST\u201d request to create a record in the table. Now choose Table Name as \u201cIncident\u201d<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- Login to your developer Instance with the credentials generated in the previous step.<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- After successful login, ‘Request’ a ServiceNow Instance (it’s good to select same location of instance as your client\u2019s\/company\u2019s ServiceNow Instance location). Note the credentials of your requested instance.\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- Setup developer instance on ServiceNow –\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- ServiceNow Setup Part<\/span>\u00a0<\/strong>–<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
- Execution Flow Diagram<\/span>\u00a0<\/strong>–<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n
- Azure LogicApp Creation Part – In this part, we will create our code logic (using LogicApp Designer) to integrate ServiceNow and call ServiceNow API through Logic App Connectors. We will discuss two different types of LogicApp connectors which can be used alternatively to Integrate Azure Alerts with ServiceNow.\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- ServiceNow Setup Part – In this part, we will use a developer Instance of ServiceNow, to find ServiceNow API Endpoints, Header content, Request Body etc and use these details in our Azure Logic App.\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- This makes the RCA Tracking process more fluent for each captured Issue, as we have a better view of ongoing issue trends and respective RCAs. This time tracking of RCAs is more precise.<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- Monitoring of Application or Infrastructure is a crucial aspect during Application Operations which can ultimately lead to improvement scopes for both Infrastructure and Application itself. ITSM tools (like ServiceNow) when integrated with any monitoring system (like azure alert) to automatically respond with Incident\/Ticket when an issue is captured by Azure Alerts, will optimize the flow of Infra\/Application improvement. These new tickets can be included (linked) with the ongoing Topics, Sprint Cycles, or new releases.\u00a0<\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- When each deteriorated system condition is recorded, managed and maintained through a ticket, then this may increase accountability and answerability<\/em>.<\/em><\/strong><\/li>\r\n<\/ul>\r\n\r\n\r\n\r\n
- Introduction and relevance of this Integration<\/strong><\/span> –<\/li>\r\n<\/ol>\r\n\r\n\r\n\r\n