ServiceNow (Webhook Integration)
ServiceNow
The ServiceNow integration allows Alerts to be delivered to ServiceNow.
Note: Before you can use ServiceNow as a target for alerts delivery, you need to configure a ServiceNow Integration and URL that can receive a POST request.
With ServiceNow, you can:
Manage incidents and the lifecycle of incidents
Correlate with other systems inside of ServiceNow
Gather incidents in an already existing ServiceNow setup
Overview
Setting up ServiceNow Integration from within the ServiceNow Portal
Step | Screenshot |
---|---|
To use ServiceNow as an Apica Target for Webhook delivery, configure OAuthaccess in ServiceNow from their Application Registry Menu. When you are signed in to your ServiceNow instance as an administrator, you can configure OAuth 2 access in the Application Registry. | |
Open the Application Registry To open the Application Registry:
| |
The ServiceNow Application Registry contains a list of applications that are registered for OAuth 2 authorization. | |
Add Credentials To add a new set of credentials:
| |
A new application is created.
| |
| |
The application is added to the OAuth Provider table. |
You have now Registered/added the Application to the ServiceNow Application Registry.
Next: you need to get the Servicenow Credentials From ServiceNow Portal to use for authenticating the Webhook.
ServiceNow documentation
For more details, see the ServiceNow documentation:
Integration ServiceNow Credentials (From ServiceNow Portal)
Getting the OAuth Credentials for Authentication
Now that you registered the Application with ServiceNow, you need to send Webhooks to it and need to authenticate your Webhook. This is how to get the credentials so you can enter them into the Webhook from the Apica side.
So, when you need the OAuth settings for the Apica Webhook target, you can find them in the ServiceNow Application Registry.
Steps | Screenshot |
---|---|
1. Open the ServiceNow Application RegistryTo open the Application Registry:
| |
Find and Get the CredentialsThe ServiceNow Application Registry contains a list of applications that are registered for OAuth authorization. To find credential details:
|
|
| |
The OAuth Client IDThe Client ID is displayed in plain text in the Client ID box and can be copied directly. Copy this for the first part of the ServiceNow Webhook integration Authentication | |
The Client SecretThe Client Secret is hidden by default, so you need to display it in plain text in order to copy it. View the Client Secret by clicking the padlock next to the Client Secret box
Copy this for the second part of the ServiceNow Webhook integration Authentication |
You now can Authenticate to the ServiceNow services to pass the Webhook information.
NEXT STEPS
You now need to pass ServiceNow the Webhook parameters it needs.
Webhook ServiceNow Parameters (From ServiceNow Portal)
Add parameters to alerts when an incident is created or resolved.
Details about these parameters in ServiceNow are beyond the scope of this document but here’s a brief summary.
Overview
You can view details about incident parameters in the ServiceNow REST API Explorer.
Open API Explorer
Step | Screenshot |
---|---|
Login
| |
Open the REST API Explorer
The REST API Explorer is shown. | |
In the API Explorer, you can select the Incident table and view details about the parameters. Find Incident ParametersTo find information about a parameter: | |
|
|
| |
| |
| |
|
Next Steps
Get/record the User Names/User ID from ServiceNow Portal.
User Names/ID (From ServiceNow Portal)
User names (User ID) are used in ServiceNow targets, both for the access control, and to define incident caller.
Here’s how to get the User Names/User ID for your ServiceNow Webhook-enabled Alert targets.
Find User ID
Step | Screenshot |
---|---|
To find the User Name for a particular user:
| |
Find Organization in the navigation
|
ServiceNow Username
The Username is the user name that logs into the ServiceNow instance.
View
This can be any valid and active ServiceNow user.
Copy the user name from your ServiceNow User Names/ID (From ServiceNow Portal) and paste it into the text box.
ServiceNow Short Description
Short Description
The Short description used in ServiceNow incidents created from alerts, to populate the short description
field.
View
You can use Message Placeholders in the description to add dynamic information from the check.
Enter a descriptive text for the alert/incident in the text box.
ServiceNow Client Secret
Client Secret
The Client Secret is the OAuth client secret configured in ServiceNow.
View
Copy the Client Secret from a Webhook ServiceNow Integration OAuth Credentials in your ServiceNow instance and paste it into the text box.
ServiceNow Client ID
Client ID
The Client ID is the OAuth authentication identifier of the ServiceNow.
View
Copy the Client ID from the Webhook ServiceNow Integration OAuth Credentials in your ServiceNow instance and paste it into the text box.
Creating ServiceNow Target
Note: For ServiceNow delivery to work, you need to configure the ServiceNow Integration custom integration in ServiceNow.
Prerequisites
From the ServiceNow Portal, once you have:
Integrated ServiceNow from their Portal (Registered the Application in ServiceNow)
Gotten the Service Application Credentials
We can now set up the alert target from within ASM. The configuration for a custom ServiceNow WebHook target consists of multiple sections.
Step | Screenshot |
---|---|
Create a ServiceNow Target To add a ServiceNow target, click the WebHook button | |
A blank target is created: | |
Navigate down to ServiceNow | |
Add the ServiceNow “Target” Fields Target Name
Host
Client ID
Client Secret
Username
Password
Caller
Short Description
Creating Incident
Resolving Incident
|
|
Add WebHook Target
|
Can't find what you're looking for? Send an E-mail to support@apica.io