Back to Kinetic Platform Integrations
Handler · Version 3

Kinetic Agent Handler Execute Kinetic Platform

Download GitHub


This handler executes Agent Handlers that have been installed on a configured Agent.


  • Kinetic Platform v5+ is required to run this handler

  • Before using this handler, an Agent must be installed and configured within the Space Admin consoles (Space > Settings > Platform Components > Agents).

The handler works by calling the Kinetic Agent (proxying through the Kinetic Platform for added security) and giving it the slug of the handler which should be run. From there the Agent will execute the handler adapter. The results from the handler being executed within the agent adapter are returned as the output result of this handler.

Name Description Sample
api_server Kinetic Platform API Location
api_username Username of a Kinetic Platform spaceAdmin
api_password Password of a Kinetic Platform spaceAdmin *********
enable_debug_logging Enable debug logging if the value is set to 'Yes'. No
Name Description Sample
Error Handling Determine what to return if an error is encountered. Error Message
Agent Slug The slug of the agent that contains the handler to execute. (Configured in Space > Platform Components > Agents)
Handler Slug The slug of the handler to execute. ex on-prem-incident-create bar
Payload The parameter-to-value mappings of the handler that is being executed in JSON format. ie {"baz": "buz"} <%= {"parameter_1" => "ABC", "parameter_2" => "123"}.to_json %>
Name Description
Handler Error Message Error message if an error was encountered and Error Handling is set to "Error Message".
'Name of Node'

Kinetic Agent Handler Execute V1 (2019-10-30)

  • Initial version. See README for details.

Kinetic Agent Handler Execute V2 (2020-02-05)

  • Updated how errors are handled.

Kinetic Agent Handler Execute V3 (2020-04-20)

  • Updated to return outputs of the handler that is being called, and not the single "output" parameter
  • Updated info values to proxy through the Kinetic Platform (not direct to Agent using the configurator user)
Download GitHub

On This Page

Looking for a workflow engine? Learn more about the Kinetic Data Enterprise Workflow Platform. Check it out
Return to Top