Step: FreshService

This step lets you send a query to the FreshService API service using your account's API key and password. The step utilizes the Web Data Source to set up the connection, and then allows both GET and POST requests to FreshService. Responses are stored in package table variables to be used in other steps. (Introduced in DarkLight 5.7.1)


Can use table variable values

Allows FreeMarker Expressions

Requires FreshService API Key

  • Source: Select a Data Source of type Web
    • The URL field should contain at least the base URL for your FreshService server (e.g. if you will only being posting tickets you could put the whole URL in this field, too.)
    • Enter your ThreatConnect username in the Username field
    • Enter your ThreatConnect password in the Password field
      • If you are using an API Key instead of a name/password, put it in the password field and leave Name empty.
    • KeyStore is not used
  • Path to Query: Enter the remainder of the API URL (e.g. /helpdesk/tickets.json) if needed.
    • Use GET to request information, and POST to push information.
    • Refer to FreshService API Documentation for details on URLs.
    • This field allows FreeMarker expressions so you can include values previously stored in your playbook package. (e.g. ${host[0][0]}
    • The full resulting URL will be shown below this box so you can preview what will be sent. (FreeMarker expressions will be resolved before they are sent.)
  • Headers: These are pre-filled with the default values used by the API, but additional headers can be added if needed.
  • Body: Used with a POST to create the data sent to the server. This field allows FreeMarker expressions so you can include values previously stored in your playbook package.
  • Output Variable: The name of the variable that any response messages will be stored in. The value can be referenced in subsequent steps with the FreeMarker expression ${output}
  • step/freshservice
  • Last modified: 2019/03/27 23:53