Edit HTTP Trigger Unit

Edit HTTP Trigger Unit

Overview

Trigger Units are responsible for starting the execution of a flow. They define how and when a flow is triggered. A flow always begins with a Start Unit, and immediately after that comes a Trigger Unit. The following trigger units are supported:
  1. Timer - Triggers the flow at a scheduled time or at recurring intervals.
  2. Queue - Initiates the flow when a message is received.
  3. Subscription - Triggers the flow based on subscribed events or notifications.
  4. HTTP - Starts the flow when an HTTP request is received.
This article provides information about the HTTP trigger unit. The HTTP Trigger Unit is used to expose a flow as an API endpoint. It starts the flow whenever an HTTP request is received from an external system.
Common Usage:
  1. REST APIs
  2. Webhooks
  3. Real-time integrations
  4. System-to-system communication
What does an HTTP trigger do?
  1. Listens on a defined URL
  2. Accepts HTTP requests (GET, POST, PUT, DELETE)
  3. Validates request (if schema defined)
  4. Starts flow execution
  5. Returns a response
To view and modify the unit name, description, and other properties, click on the unit.

Accessing HTTP Trigger Unit Properties

  1. To view/modify the HTTP Trigger unit property, click on the HTTP trigger unit. Upon clicking the unit, a property panel opens below, and the unit gets highlighted.
  2. The property panel will open and display the following sections:
    1. Input
    2. Processing
    3. Output
  3. By default, all sections are displayed unless you have specified panel settings in the user settings.
Image

Input Section

  1. The Input section provides the details on the inbound message, and the following tabs are provided in the section:
    1. Data section: The Data section provides the name of the processed units of the flow.
    2. Message: The Message section displays the inbound message of the selected unit. 
Image

Data Section

  1. The section provides details on inbound messages and lists units that have already been processed. The following sections will be shown:
    1. Variables Section:
      1. A variable is a named container used to store data temporarily during execution.
      2. It allows you to store values, reuse data, pass information between units, and perform calculations and conditional checks.
      3. The supported variables are:
        1. Local variables: A local variable is available only within a specific unit or a limited scope (like inside a Decision or For-Each unit). It is accessible only in the unit where it is defined. Not available outside that unit.
        2. Global variables: A global variable is available across the entire flow. It is accessible from any unit of the flow. It retains value during flow execution. 
      4. Click on the Variable section to view the configured variables. Upon clicking the Variable, the list of variables will be shown.
    2. Inbound Document:
      1. The Inbound Document in a Trigger Unit defines the structure of the incoming request message that starts the flow. It acts as the input schema for the flow.
      2. The Inbound document used:
        1. To define the expected request format
        2. To validate the incoming payload
        3. To expose fields in the Expression Builder
        4. To act as the input contract of the API/Trigger
      3. Click on the Inbound Document section to view the inbound messages. Upon clicking the Inbound Document, the details will be shown. 
Image
  1. A Search option is also provided to search for the unit name from the list.
  2. Enter the unit name in the search field, and the result will be displayed instantly.
  3. To close the search, click on the Clear (x) icon. 
Image
  1. A Sort icon is provided to arrange the list as needed.
  2. You can also arrange the units either in ascending order (A to Z) or descending order (Z to A) using the icon next to the search icon. By default, the units are arranged in ascending order.
  3. Click the Sort icon to switch to descending order.
  4. Click again to return to the default ascending order.
Image
  1. A Collapse icon is provided next to the Sort icon. You can use this function to increase the message's working area for better readability and more space.
  2. Click on the icon to collapse the listing. 
Image
  1. After clicking the Collapse icon, the listing collapses.
  2. However, you will still be able to view the icon of the respective units.
  3. When you hover over the icon, you can view the names of the units. Additionally, you can click any link to view its message.
Image

Message Section

  1. You can view the message of any of the units listed in the Data section.
  2. To view the message of any unit, click on the unit in the Data section. The message will be displayed instantly. 
Image
  1. A search option is also provided to find any node in the message.
  2. Enter the node name in the search field, and the result will be displayed instantly and highlighted.
  3. If more than one result is displayed, a navigation icon and a results counter are provided. You can navigate through the search results using the navigation icons.
  4. To close the search, click the 'x' icon. 
Image

Legends

  1. A legend icon is provided to help you understand the message. The color of the nodes indicates their status.
  2. Click the Legend icon to view the details. When you click the icon, the list will show the legend used in the message.
Image

Adjust Message Font Size

  1. A Font Size box is provided to increase or decrease the message's font size.
  2. The current font size will be shown in the box.
  3. Click on the box to increase or decrease the font size. 
Image
  1. After clicking the Font Size box, a slider will appear below it.
  2. Use the slider to increase or decrease the font size. 
  3. As you slide, the change in size will be reflected in the message instantly.  
  4. The supported font size ranges from 8 to 72.
Image

Switch Between Code and Tree View

  1. By default, the message will be displayed in Tree View.
  2. Click on the Switch to Code View icon.
Image
  1. The inbound message gets switched to code view.
  2. Click the icon again to switch back to tree view mode.
Image

View/Modify Input Message (Tree View)

  1. You can view the inbound message in tree/code view.
  2. By default, the message will be displayed in tree view. Switch to tree view mode if you are in code view.
  3. Please note that you cannot edit a message in tree view mode. The message will be displayed in read-only mode. To edit the message, switch to code view. 
  4. The tree view provides the following icons in the toolbar:
    1. Find: This option allows you to find any parameter in the inbound message.
    2. Font Size: You can set the message font for clearer viewing. The available font size range is from 8 to 24. Select the desired value from the drop-down.
    3. Show Legend: Provide the list of the legend used in the message.
Image

View/Modify Inbound Message (Code View)

  1. To view the message in code view, switch to code view by clicking on the icon.
Image
  1. The code view will show the message in XML format. You can edit the message in this mode as needed.
  2. A toolbar is provided to help you to edit the message efficiently. The code view provides the following icons in the toolbar:
    1. Cut: 
      1. Function: Removes the selected text or object from its current location and places it on the clipboard.
      2. Use Case: Moving content from one place to another.
    2. Copy:
      1. Function: Copies the selected text or object to the clipboard without removing it from its original location.
      2. Use Case: Duplicating content.
    3. Paste:
      1. Function: Inserts the clipboard content into the current location.
      2. Use Case: Adding previously cut or copied content.
    4. Find:
      1. Function: Searches for specific text or patterns within the document or code.
      2. Use Case: Quickly locating words, phrases, or code snippets.
    5. Replace:
      1. Function: Finds specific text and replaces it with new text.
      2. Use Case: Updating repeated terms or correcting errors throughout a document.
    6. Beautify:
      1. Function: Formats code or text to make it more readable and properly indented.
      2. Use Case: Cleaning up messy code for better readability.
    7. Word Wrap:
      1. Function: Ensures that long lines of text automatically wrap to fit within the visible window without horizontal scrolling.
      2. Use Case: Easier reading and editing of long lines.
    8. Maximize: 
      1. Function: Expands the editor or window to full screen for better focus and visibility.
      2. Use Case: Working without distractions or seeing more content at once.
  3. Once you have modified the message, click the Save button to save the changes.
Image

View Variables

  1. The section will display the defined variables. You can create global or local variable on the section.
  2. To open the Variable section, click on the Variable menu.
Image
  1. A list of the variables gets displayed. The list provides both global and local variables.
    1. Global Variables: 
      1. A global variable is one declared at a higher level and accessible from any part of the flow.
      2. Key Characteristics: 
        1. Accessible throughout the entire flow
        2. Can be used by multiple units
        3. Retains its value during the flow execution
      3. When to Use:
        1. Shared configuration values
        2. Data that must be reused across multiple units
        3. Environment-level settings
    2. Local Variables:
      1. A local variable is declared inside a specific unit or block and can only be accessed within that scope.
      2. Key Characteristics: 
        1. Limited visibility
        2. Exists only within the unit
        3. Not accessible outside the specific unit
      3. When to Use:
        1. Unit-specific logic
        2. Temporary calculations
        3. Intermediate processing values
Image

Add Variables

  1. To add variables, click on the (+) icon as shown on the screen.
Image
  1. An Add Variable pop-up will appear, displaying the following fields. All fields are mandatory.
  2. Variable Name:
    1. It is a text field; you can enter the variable name in this field.
    2. You are free to use any name of your choice.
  3. Scope:
    1. You need to select the variable scope from the drop-down.
    2. The following scopes are provided in the drop-down:
      1. Local: A local variable is declared within a specific unit and can be accessed only by that unit. 
      2. Global: A global variable is one declared at a higher level and accessible to all units from any part of the flow.
  4. Variable Type:
    1. Once you have selected the scope, select the variable type from the drop-down.
    2. The following variable types are available:
      1. Fixed: A fixed variable has a constant value that you manually define, and it does not change during execution. 
      2. User: A user variable gets its value from user input.
      3. Expression: An expression variable is calculated using logic or formulas.
  5. Once you have filled all the fields, click on the Add button.
  6. Click Cancel to close the pop-up.
Image
  1. The newly added variable gets added to the list.
  2. Now you can edit the variable and set the values.
Image

Edit Variables

  1. To edit any variable, hover over the variable band and click on the Edit icon.
  2. Based on the variable type, the edit screen will open.
Image

    Edit Fixed Variable Type

    1. Clicking the edit icon opens the Fixed Variable pop-up.
    2. You can modify the value in the Value field. This field is mandatory and cannot be left blank.
    3. Once the modification is complete, click the Save button.
    4. Click on the Cancel button to close the pop-up. 
    Image

    Edit User Defined Variable Type

    1. Clicking the edit icon opens the User Variable pop-up. You can modify the following fields:
      1. Label: This field allows you to change the label of the variable.
      2. Description: This field allows you to change the existing description.
      3. Mandatory: Make the variable mandatory or non-mandatory using the Yes or No from the drop-down. 
      4. Data Type: This field allows you to set the data type for the selected variable. 
      5. Default Value: Set the default value for the selected variable. 
    2. Once the modification is complete, click the Save button.
    3. Click on the Cancel button to close the pop-up. 
    Image

    Edit Expression Variable Type

    1. Clicking the edit icon opens the Expression Variable pop-up.
    2. You can modify the existing expression of the variable. You can define the expression in the expression field. If you need any variable in your expression, you can drag and drop it from the list. Please note that you cannot use (drag & drop) the selected variable in your expression. 
    3. Once the modification is complete, click the Save button.
    4. Click on the Cancel button to close the pop-up.
    Image

    Delete Variables

    1. To delete any variable, hover over the variable band and click on the Delete icon.
    Image
    1. A Delete Variable pop-up will appear.
    2. Click on the Yes button to delete the chosen variable.
    3. Click on the No button close the pop-up.
    Image

    Processing Section

    The Processing section provides configuration details for the HTTP trigger unit and includes the following tabs. You can switch between the tabs by clicking on them:
    1. Details Tab: The Details Tab contains the flow's general information and basic properties. Typically includes the unit name and its description.
    2. Design: The Design Tab is the visual workspace where you build the actual flow logic. Typically includes request document, key handling, error handling, etc.
    Image

    Details Tab

    The Details tab provides basic details of the HTTP Trigger unit, including its name and description. The Details tab is displayed by default. It provides the following fields:
    1. Name: 
      1. The unit name is provided in this section, and you may modify the existing name within this field.
      2. Click the field to update the unit's name.
      3. Upon completing the modifications, click the 'Save' button in the action area of the screen.
    2. Description: 
      1. This field describes the processing unit, and you can modify the existing description.
      2. Click the field to edit the unit's description.
      3. Once you are done with the modification, click the Save button in the action area of the screen.
    Notes
    The Name field supports 50 characters, letters, digits, dots, hyphens, and underscores. Whereas the Description field has no limitations.

    Image

    Design Tab

    1. To switch to the Design tab, click it. The Design tab provides configuration details for the Timer Trigger unit.
    2. The screen displays the Trigger section with the selected trigger. In this case, the HTTP is displayed.
    3. To expand the Trigger section, click on the band, and the section will display the following fields:
      1. Trigger
      2. Message Handling
    Image

    Trigger

    1. Click on the Trigger section.
    2. Once expanded, the following fields get displayed:
      1. Event
      2. Authentication Type
      3. Execution Type
      4. HTTP Method
    3. All fields are mandatory. 
    Image
    Event
    1. Once expanded, the Event drop-down field will display the HTTP Call value.
    2. By default, the HTTP Call is displayed as you have configured your automation with an HTTP Call trigger.
    3. You can choose any other trigger from the drop-down. If you select a different trigger, you need to save the change for it to take effect.
    Image
    Authentication Type 
    1. The Authentication Type drop-down field will display the existing authentication type.
    2. The authentication type you selected when creating the automation will be displayed in the field. However, you can modify it from the drop-down using available options. 
    3. The following types of authentication are supported:
      1. No Authentication
      2. Basic Authentication
      3. Token-Based Authentication. 
    Image
    Execution Type
    1. The Execution Type drop-down field will display the existing execution type.
    2. The execution type you selected when creating the automation will be displayed in the field. However, you can modify it from the drop-down using available options. 
    3. The following types of execution are supported:
      1. Synchronous Execution
      2. Asynchronous Execution 
    Image

    HTTP Method
    1. The HTTP Method drop-down field displays the available HTTP methods.
    2. Select an appropriate HTTP method for your trigger.
    3. If you have already configured the HTTP method, the existing method will be displayed in the drop-down. However, you can modify it from the drop-down using available options. 
    4. The supported HTTP methods are GET, POST, PATCH, PUT, DELETE, HEAD, OPTIONS, TRACE, and CONNECT. 
    Image

    Message Handling

    1. Click on the Message Handling section.
    2. Once expanded, the following fields get displayed:
      1. Message Type
      2. Message
    3. All fields are mandatory. 
    Image
    Message Type
    1. The Message Type drop-down field allows you to configure the message type.
    2. Select an appropriate message type from the drop-down.
    3. If the message type is already selected, you can modify it using the drop-down options. If you select a different message type, you need to save the change for it to take effect.
    Image
    Message 
    1. The Message drop-down field allows you to configure the message for the selected message type.
    2. Select an appropriate message from the drop-down.
    3. If the message is already selected, you can modify it using the drop-down options. If you select a different message, you need to save the change for it to take effect.
    4. Once all the fields are configured/modified, click on the Save button to apply the change.
    Image

    Output Section

    The Output section displays the unit's final output message. The Output Message of the system call unit is the data generated after the unit completes execution. This final output of the unit is then passed to the next unit in the flow. The Output section provides the message in XML and JSON formats. You can switch between the tabs by clicking on them:
    1. Message Tab
    2. JSON Message Tab


    Message Tab

    1. By default, the Message tab is displayed, and the message is shown in tree view mode.

    Search

    1. A search option is also provided to find any node in the message.
    2. Enter the node name in the search field, and the result will be displayed instantly and highlighted.
    3. If more than one result is displayed, a navigation icon and a results counter are provided. You can navigate through the search results using the navigation icons.
    4. To close the search, click the 'x' icon. 
    Image

    Legends

    1. A legend icon is provided to help you understand the message. The color of the nodes indicates their status.
    2. Click the Legend icon to view the details. When you click the icon, the list will show the legend used in the message.
    Image

    Adjust Message Font Size

    1. A Font Size box is provided to increase or decrease the message's font size.
    2. The current font size will be shown in the box.
    3. Click on the box to increase or decrease the font size. 
    Image
    1. After clicking the Font Size box, a slider will appear below it.
    2. Use the slider to increase or decrease the font size. 
    3. As you slide, the change in size will be reflected in the message instantly.  
    4. The supported font size ranges from 8 to 72.

    Switch Between Code and Tree View

    1. By default, the message will be displayed in Tree View.
    2. Click on the Switch to Code View icon.


    JSON Tab

    1. Click the JSON Message tab to view the message in JSON format.
    2. You can view the Output message in the tree/code view.
    3. By default, the message will be displayed in tree view. Switch to tree view mode if you are in code view.
    4. Please note that you cannot edit a message in tree view mode. The message will be displayed in read-only mode. To edit the message, switch to code view. 
    5. The tree view provides the following icons in the toolbar:
      1. Find: This option allows you to find any parameter in the inbound message.
      2. Font Size: You can set the message font for clearer viewing. The available font size range is from 8 to 24. Select the desired value from the drop-down.
      3. Show Legend: Provide the list of the legend used in the message.
    1. To view the message in code view, switch to code view by clicking on the icon.







      • Related Articles

      • Edit HTTP Call Unit

        Overview An HTTP Call Unit in a flow diagram is used to make HTTP requests to external services or APIs within your workflow. It’s a way to integrate your process with web-based systems. What it does: Sends an HTTP request (GET, POST, PUT, DELETE, ...

      • Edit Subscription Trigger Unit

        Overview Trigger Units are responsible for starting the execution of a flow. They define how and when a flow is triggered. A flow always begins with a Start Unit, and immediately after that comes a Trigger Unit. The following trigger units are ...

      • Edit Queue Trigger Unit

        Overview Trigger Units are responsible for starting the execution of a flow. They define how and when a flow is triggered. A flow always begins with a Start Unit, and immediately after that comes a Trigger Unit. The following trigger units are ...

      • Edit Timer Trigger Unit

        Overview Trigger Units are responsible for starting the execution of a flow. They define how and when a flow is triggered. A flow always begins with a Start Unit, and immediately after that comes a Trigger Unit. The following trigger units are ...

      • Edit Start Unit

        Overview The Start Unit is the entry point of a flow in the Automation Flow Designer/Editor. It defines when and how an automation flow is initiated and marks the start of execution. The start unit is mandatory for the flow, where you need to define ...