Resthooks

In the Composition tab, the resthook option is available within the Integration menu. It is used to make a REST call to an external system.

Procedure

  1. Drag-drop Integration >Resthook in your flow on the right pane.
  2. In the Basic Information tab, enter the following values for Resthook:

    • Activity Id - The activity Id is automatically generated and is in read-only mode.
    • Title - Enter the name or the title of the Resthook.
    • Input URL - Enter the URL where payloads are delivered.
    • Method - Select the Method. It includes GET, POST, PUT, PATCH, and DELETE.
    • Payload - Enter request or response body. Quotes must only be added for parameters of type String or Password. For Counter, List and Map, you have to stringify the JSON if any of the parameter value is a linked parameter.

      For example, name is a string and amount is a non string:

        { 
          \“name”: \“${param.name}\”, 
          \“amount\”: "${param.address}" 
        }
      
  3. In the Header/Auth tab, enter the following values:

    • The KEY and VALUE are displayed for existing header keys and header values. Click Edit to add or delete header keys. You cannot edit an existing header.
    • Auth Type - Select the authentication mechanism. Basic is the only authentication type supported in this release.
    • Auth Username - Enter the user name for Resthook authentication management system to which you want to add an entry after a template is deployed. You can use Resthook to connect to the IT asset management system to create an entry.
    • Auth Password - Enter the password for Resthook authentication. For example, a REST API enabled IT asset.