Creating Integration Key

Creating Integration Key

For builds after 11300, Steps to create Integration Key:
  1. Goto Admin > Integrations > Integration Key > New
  2. Please use an integration key with admin privilege, as there wont be any role related permission issues. 
  3. Click Generate link under the Integration key details block. You can select a time frame for the key to expire using the calendar icon  or simply retain the same key perpetually.
  4.  
  5. If a key is already generated, then you can view the integration key from the existing list.

  6. Enter the login password to view the already generated Integration key



For builds prior to 11300, Steps to create Technician Key:
  1. Goto Admin -> Technicians icon under User block.
  2. If you want to generate the API key to the existing technician, click the edit icon  beside the technician. If you want to generate the API key to a new technician, click Add New Technician link, enter the technician details and provide login permission.  
  3. Preferably use a technician with SDAdmin privilege to avoid any role related permission issues. 
  4. Click Generate link under the API key details block. You can select a time frame for the key to expire using the calendar icon  or simply retain the same key perpetually. If a key is already generated for the technician, a Re-generate link appears.
  5.  
  6. The key in the above image is generated for an existing technician. A time frame for the key is selected which shows the date, month, year and the time (in hours and minutes) when the key will expire.
  7. Refer: https://help.servicedeskplus.com/api/rest-api.html$key 
If you are using Custom Function scripts for integration, then update the configurations global_functions with the generated API key..  Refer to the below screenshot


If you are using python\powershell for scripts integration, then update the configuration.json with the generated API key. Refer to the below screenshot.


      • Related Articles

      • Azure DevOps Integration

        Feature:  Azure DevOps Integration <-->  ServiceDeskPlus (Plugin Model) --> Create a new work-item in Azure DevOps when a request is created in SDP --> Update SDP request status when a Azure DevOps work-item status is updated --> Updating Comments ...
      • ServiceNow Integration

        Establishing two-way communication between ServiceDesk Plus and ServiceNow is done in 4 steps.  It can be achieved using Python scripts by installing Python runtime in builds older than 11120 but with newer builds, it can be done with Deluge scripts ...
      • How to auto-create worklog based on values specified in the request

        This post will to help you create a worklog automatically when a request is created. This script can be configured under Request custom triggers and you will find more information about this here. This is achieved using an API call to create a ...
      • Slack Integration

        This is a sample python script that is used to post request details from ServiceDesk Plus into Slack.Slack is a cloud-based team collaboration tool that allows team members to communicate without the use of emails or group SMS. Use Case: Lets assume ...
      • Cisco Webex Integration

        Requirement: Integrate WebEx teams with ServiceDesk Plus (On-Premise) application to notify team space in WebEx Teams whenever Severity – 1 and Severity – 2 incidents are reported. Also, it would be easier if the alert message has the request field ...