Creating a Flow with a REST (Receive HTTP Message) Trigger

When creating a flow with a REST trigger, you have the option to either enter the schema in the Add a trigger dialog while creating the flow or you can start by using a Swagger-compliant JSON file to create the flow.

You can create a REST flow by entering a JSON schema or dragging and dropping a Swagger-compliant JSON file. See Using a Swagger 2.0 Compliant File section for how to use a Swagger file.

To create a REST flow by entering the schema, do the following:

Procedure

  1. Click an app name on the Apps page in TIBCO Cloud Integration- Flogo (PAYG) to open its page.
  2. Click the Create button.
    The Create flows and triggers dialog opens.
  3. Enter a name for the flow in the Name text box.
    Flow names within an app must be unique. An app cannot contain two flows with the same name.
  4. Optionally, enter a brief description of what the flow does in the Description text box.
  5. Select New flow and click Create.
  6. Select Start with a trigger.
    The Add a trigger dialog opens with all the available triggers showing.
  7. Click Receive HTTP Message, the REST trigger.
    The Add a trigger dialog opens.
  8. Select the REST operation you want to implement by clicking on the box for the operation under Method.
    Note: A flow can have multiple REST triggers. Two REST triggers cannot have an identical port, path, and method combination. Each REST trigger needs to differ from the other REST triggers for the same flow with either a unique port, path, or operation (GET, PUT, POST, DELETE).
  9. Enter a resource path in the Resource Path text box.
  10. Enter the JSON schema or JSON sample data for the operation in the Enter a JSON Schema or an example of your JSON message. This will be the schema for both input and output.
  11. Click Continue.
  12. If this is the first REST trigger you are adding to the flow, you get the following dialog:

    If you select Copy Schema, the schema that you entered in step 9 above gets automatically gets copied or displayed in a tree format to the following locations when the trigger gets added:
    • Trigger output in the Map to Flow Inputs tab of the trigger
    • Flow input in the Input Settings tab of the Flow Inputs & Outputs accordian tab.
    • Trigger reply (If the trigger has a reply) in the Reply Settings of the trigger.

    Refer to the "REST Trigger" section in the TIBCO Flogo® Activities and Triggers Guide for details on configuration parameters.

    If you select Just add the trigger, a REST trigger gets added to the flow without any configuration. You can configure this REST trigger by clicking on it at a later time.

    The flow page opens with the Input Settings tab of the Flow Inputs & Outputs accordian tab open.

  13. Collapse the Flow Inputs & Outputs tab to see the buttons for adding activity in the flow.
  14. Map the trigger output to the flow input.
    1. Open the trigger configuration dialog by clicking on the trigger.

    2. Open the Map to Flow Inputs tab.
    3. Map the elements under Flow input to their corresponding elements under Trigger Output one at a time.
  15. Map the flow output to the trigger reply as follows:
    1. In the trigger configuration dialog, click the Map from Flow Outputs tab.
    2. Map the elements under Trigger Reply to their corresponding elements under Flow Output one at a time.
    3. Close the dialog by clicking on the x at its top right corner.
  16. Add activites to the flow by hovering your mouse cursor next to the Flow Inputs & Outputs tab and clicking the plus sign.