Skip to content

Manage Your Tool

Sync/Async Mode Setup

You can set the sync/async mode configuration for the tool endpoint. If you change the mode, you must redeploy the tool. The key difference is that synchronous mode blocks the client until the response is received, while asynchronous mode allows the client to continue working while the integration processes the request.

Steps to enable and configure the asynchronous mode:

  1. Log in to your account and click Tools from the list of modules.
  2. Click the Tools tab on the top navigation bar, and select the tool to modify its configuration. The Tool Flow page is displayed.

  3. Click Configurations in the left navigation and then click Setup sync/async.
    Setup sync/async

  4. The Sync/Async mode setup pop-up displays with async mode disabled by default.

    • Synchronous mode timeout: The allowed range is 60 to 300 seconds (5 minutes). The default is 180 Seconds (3 minutes). The endpoint will trigger a timeout error if the request is not completed within the selected time frame.
      Sync Mode Timeout

    • Asynchronous mode configuration: Turn on the Enable async toggle and do the following:

      1. Provide the URL of your external application to which messages are to be delivered.
      2. Enter the access token generated by the external application.
      3. Set the Asynchronous mode timeout duration:
        • Set timeout: The allowed timeout range is 60 seconds to 600 seconds (10 minutes). The default is 180 Seconds (3 minutes).
        • No timeout: This allows the tool to process the request without a time limit.
          Async Mode Configuration
      4. Click Save.

    Note

    Timeout precedence: Tool timeout > Node timeout > Model timeout.

  5. If you have changed the mode, you must redeploy the tool: Go to Tool endpoint in the left navigation and click the Deploy button on the top-right corner of the page.

Undeploy the Tool

You can undeploy the tool if it's no longer in use. Undeploying the tool will result in an immediate disconnection from all active instances. Click Proceed to undeploy on the Configurations page and follow the on-screen instructions.

Delete the Tool

You can delete an undeployed tool. Deleting the tool will remove all the associated data. Click Proceed to delete on the Configurations page and follow the on-screen instructions.