SysAid

Before you start

• You must use your SysAid account credentials and not SSO credentials to generate an access token. You can find them by going to your user profile in SysAid.

• Authentication is limited to one SysAid account at a time - the generated access token will only be able to access data from that specific account.

---

Step 1: Create a SysAid Application Authentication

1. SysAid Application

   • A SysAid application is required for the alerter.

     • Please make sure you have a working SysAid application beforehand.

   • Please refer to SysAid Getting Starter Guide as needed.

2. Create application key

   • Navigate to the Developer Documentation for SysAid public API

     • Navigate to Create Application Key section.

     • Fill in the userName and password for your SysAid Account Credentials and applicationName of the already created SysAid Application.

       

       SysAid Credentials
     • Fill in the tokenLifetime as necessary, though default (24 Hrs) is sufficient.

     • Make sure to fill the Header and the URL with the x-sysaid-accountid, which is your SysAid Account ID.

       

       SysAid Account ID fill in
   • Make sure to note down the response clientId, clientSecret and the applicationName for further use.

     

     Application Authentication Credentials

---

Step 2: Gather Service Record Details

1. Service Record Type - Incidents

   • The service records of type Incidents are created with each alert.

   • The default Incident type Service Record Template is used, if you need to change that, please note the templateId need to be used.

   • Please note the following data related to the above templateId,

     • requestUser

     • assignedGroup

     • primaryCategory

     • secondaryCategory

     • secondaryCategory

     • thirdLevelCategory

2. Alternative Method

   • Alternatively, you can send an existing Incident type Service Record ID to be used as the template.

---

Deliverables

Please email to [e-mail]:

1. Application Credentials:

   • Please make sure the following credentials are noted in the email.

     • x-sysaid-accountid

     • applicationName

     • clientId

     • clientSecret

2. Incident Service Record Details:

   • Please make sure you include the details or a valid service record ID

   • If including the details,

     • requestUser

     • assignedGroup

     • templateId

     • primaryCategory

     • secondaryCategory

     • secondaryCategory

     • thirdLevelCategory

   • If including a valid Incident Service Record ID,

     • The ID of the service record.