ServiceNow

ServiceNow is a cloud-based workflow automation platform that enables enterprise organizations to improve operational efficiencies by streamlining and automating routine work tasks.

Authorization

OAuth 2.0 

If the user selects OAuth 2.0, they need to enable it for their app using the developer console. For more information, follow the guide here; When a user creates the ServiceNow app, they must be sure to enter Sapper's OAuth callback URL - Sapper -as a Callback URL. Consult ServiceNow to determine the proper OAuth Scopes to assign to the credential. It is important to note the difference in the host URL when using OAuth 2.0. If the user is using OAuth 2.0, they must format the URL like the following: https://api.atlassian.com/ex/serviceNow/{cloudId}/rest/api/2/project. The user can obtain a cloud id by sending an authenticated request to the following endpoint: https://api.atlassian.com/oauth/token/accessible-resources
Now, the user will have to configure OAuth 2.0 settings in Sapper. The user should create a new credential of type OAuth 2.0 - Authorization Code. 

  • For Client ID and Client Secret, enter the values that the user got from the developer console 

  • For scopes, choose from the list found on the Atlassian Docs 

ServiceNow Connections

ServiceNow Basic Connection

 

Input 

Key 

Description

Example 

Select Application

application

Select ServiceNow application

 

Connection Mode

Mode

Mention the mode of connection

Custom

Connection type

connection type

Select the type of connection.

 

Rest Connection Type

Rest Connection Type

Select the Basic connection type

 

Connection Name

name

Provide a name for the connection.

 

Connection Description

description

Provide a description for the connection.

 

Host Name

host 

Provide a string value for the URL of user's ServiceNow account.

 

Username

username

Provide a valid username for the given ServiceNow account user want to connect. 

exampleUser 

Password

password 

Provide a password to authenticate all requests with. Cloud users need to generate an API token for this value. 

exampleSecurePassword 

Header Field

header

Provide the path of the endpoint for authentication.

 

Header Prefix

header prefix

Select the header prefix -
Basic, Bearer, Token, None

 

ServiceNow OAuth 2.0 connection

 

Input 

Key 

Description

Example

Select Application

application

Select ServiceNow application

 

Connection Mode

Mode

Mention the mode of connection

Custom

Connection type

connection type

Select the type of connection.

 

REST Connection Type

rest connection type

Select the type of REST connection.

 

Connection Name

name

Provide a name for the connection.

 

Connection Description

description

Provide a description for the connection.

 

Host Name

host 

Provide a string value for the URL of user's ServiceNow account.

 

Grant Type

grant type

Provide the grant type - Authorization code, Password, Client Credentials.

 

Actions

Get users

Get information about all the users | key: getUsers


Create user

Creates a user with the specified field names and values | key: createUser

 

Input

Key

Description

Example

Input

Key

Description

Example

User Name

userName

Provide the Username

Jql@john

First Name 

firstName 

Provide the User's First Name 

John

Last Name 

lastName 

Provide the User's Last Name 

smith

Title

Title

Provide the Title

Sample

Department

Department

Mention the department name

Sample

User Password

Password

Provide the Password of the User 

1234

Active

Active

Provide the active status

Active

Email

email

Provide the Email ID of the User

Sample@domain.com

Mobile Number

Mobile no

Provide the user mobile number

+14842989736

Roles

Role

Mention the role of the user

Admin


Update system user

Updates system user with the specified field names and values | key: updateSystemUser

 

Input 

Key 

Description 

Example 

System user id

SystemUserID

Provide the user id for the system

jbu3470

First Name 

firstName 

Provide the first name of the user

John

Last Name 

lastName 

Provide the last name of the user

Smith

User Name

userName

Mention the username of the user 

JQl@john

Employee Id

employeeID

Provide the employee id of the user.

6264

Email 

email 

Provide the email id of the user 

Sample@domain.com

 


Get Incidents

Gets an Incident by ID | key: getIncidents




Create Incident

Creates an Incident with the specified field names and values | key: createIncident

 

Input

Key

Description

Example

Input

Key

Description

Example

Short Description

Description

Provide a short description

 

Urgency

Urgency

Level of urgency

Medium

Impact

Impact

Measure of the effect of an incident

High

Assigned to

Assigned User

Identify the right User for the assignment

Admin

Assignment group

Group

Identify the right group for the Assignment

Sample group


Update Incident in ServiceNow

Updates an Incident with the specified field names and values | key: updateIncident

 

Input

Key

Description

Example

Input

Key

Description

Example

State

state

Mention the order of incident update state

Active

Close Code

Closecode

Provide the Closed Code metrics

i.e., Solved with workaround, closed ticket

Close Notes

Closenotes

Provide the Resolution/Closing incident notes

Closed


Create Company

Create a company | key: createCompany

Input

Key

Description

Example

Input

Key

Description

Example

Name

Name

Mention the company name

Sapper


Create Contract

Create a contract | key: createContract

Input

Key

Description

Example

Input

Key

Description

Example

Contract Model

Model

Mention the mode of the contract

 

Contract Number

Number

Provide the contract number for the object

6205