HTTP operator

Prev Next

The HTTP operator enables a workflow to interact with an external application or service via the configured HTTP app. This is an enabling task that facilitates the fulfillment of a user's goal by providing prerequisite functionality.

  1. Drag and drop the HTTP operator onto the workflow canvas.

  2. Click the operator to open the properties pane.

  3. In the Name field, enter a descriptive name for the operator.

  4. In the (Optional) Description field, add details about the operator.

  5. In the App drop-down, select the app configured for HTTP communication.

  6. In the App Subscription field, define the subscription associated with the app.

  7. In the Path field, provide the HTTP path, ensuring it is prefixed with a forward slash (/).

  8. In the Method drop-down, select the required HTTP method.

  9. In the Content Type drop-down, select the content type.

  10. In the Timeout field, define the maximum time (in seconds) for the request to wait for a response. The default is $300$ seconds.

  11. To add HTTP headers, click + Header and enter the name and value for each.

  12. To add URL Query Parameters, click + Query Parameter and enter the name and value for each.

  13. In the (Optional) Payload field, provide the request data in JSON format or use $ for suggestions.

  14. Under Define Success Conditions, set the rules that determine a successful response and then click Add Condition to include additional rules.

    Example: {{$.http.http.response.status}} == 200

  15. Under Configure Outputs, click + Output to define the expected outputs.

  16. Click Test Run to validate the request.

  17. To enable or disable raw response output, toggle (Optional) Include Raw Output.