Jump to a Section
  • Assign

    Create new output fields based on the input supplied.

    Input Fields

    This card has no default input fields. Input fields are created by supplying manual input or dragging-and-dropping output fields from other cards.

    Output Fields

    This card has no default output fields. Output fields are generated based on the input fields supplied.

  • Call FLO

    Run another FLO within the context of your current FLO. Your FLO will resume when the other FLO finishes. If you don’t care about waiting for the other FLO to finish, you can use Call FLO Async instead.

    Input Fields

    • flo: the other FLO you want to run
    • With these inputs (dynamically generated): The inputs defined by the FLO you want to run – these will automatically populate when you select the FLO using the Choose FLO dialog.

    Output Fields

    • The output fields must be manually created if you want to get values back from the FLO that you call. Each output field must have the same exact name and type as the value returned from the FLO. (e.g. If the FLO you call returns two strings city and state, then the output fields on the Call FLO card must be set to string and must be named city and state.)
  • Call FLO Async

    Start another FLO then continue without waiting for that FLO to finish. String together multiple Call FLO Async cards if you want to kick off different sets of actions to run at the same time, i.e. “in parallel”.

    Because the FLO doesn’t wait for the called FLO to finish, you cannot specific values for that FLO to return. If you need return values, use Call FLO instead.

    Input Fields

    flo: the FLO to be executed

    Output Fields

    No output fields.

  • Pause

    The Pause function currently only works when used in FLOs that are resumed programmatically. If you want to pause a FLO for a specific delay or until a specific time, use a Wait For or Wait Until function.

    Overview

    Pauses the FLO and returns the inputs using whatever interface was used to initiate the FLO, along with the Execution ID of the FLO, which is needed in the resume request.

    In order to resume the FLO, you will need to call the FLO again with a specific URL Endpoint, appended with the Execution ID of the execution that you would like to resume. The endpoint is similar to the one that invokes the FLO (found on the API Endpoint card’s Event Settings page), with one small change - replace ‘invoke’ with ‘resume’. Then after resume, append the URL with /{{EXECUTION_ID}}. For example, if the API Endpoint is the following: https://api.azuqua.com/flo/5f023d66e31808a8ce04954078fabc99/invoke, the endpoint that will resume the FLO is https://api.azuqua.com/flo/5f023d66e31808a8ce04954078fabc99/resume/1234SampleExecutionID0987.

    The execution ID for a given execution can be found in one of two places: 1. From the API Endpoint card itself - one of the default output fields for every monitor event is ‘Execution ID’. This value can be used as an input to another card, that will allow you do something with this field down the line in the FLO. This might be a good method for programmatically resuming the FLO. 2.

    The response from the request to the API endpoint will also include the Execution ID in the headers, so you can also retrieve this ID from the service that is originally calling the FLO.

    Input Fields

    • Create a custom input field for each value you want passed to the caller when the FLO pauses.

    Output Fields

    • Create a custom output field to correspond to each value that will be passed back to the FLO by the caller along with the resume request. To pass data to these output keys, submit them as JSON key value pairs in the body of the request. E.g. - If you have an output with the name ‘foo’, pass in “foo”:“bar” to send ‘bar’ as the value to be returned by the foo output key.
  • Pause Raw

    Pause the running FLO execution, returning raw http data to the caller. Resume it by calling the resume API.

    Input Fields

    • statusCode (Number): the status code to return to the caller.  Valid values are:  200, 400-600.
    • headers (Object): An object representing the headers for the response.  Each key of the header will be parsed into a header string as ”key: value”, i.e. “Content-Type: text/plain”
    • body (Text): The http response body.

    Output Fields

    • Headers (object): The http headers.
    • Body (text): The http body.
  • Repeat

    Runs a child FLO a specified number of times.

    There is a known bug with this function where sending values to the child FLO is not working. We are working on a fix.

    Input Fields

    • flo:  The child FLO that will be called once for each item in the list
    • with the following values (dynamically generated): The inputs defined by the child FLO - these will populate after you select the child FLO.
    • count: The number of times to repeat the child FLO.
    • concurrency:  The number of instances of the child FLO to run in parallel. If it is important that the executions are processed in sequence, use 1.  Otherwise a higher number like 5 or 10 will cause your FLO to complete sooner.

    Output Fields

    • (none)  This function does not return any outputs - use it when you want to take action a specific number of times. If you’re running once per item in a list and/or need to get values back, see the List function category for other options.

    To use this function, you first need a child FLO with the steps you want to run repeatedly. Define any inputs for the child FLO on the Child FLO event card. Your child FLO can get the current loop count by using the ”Index” field in the Context section of the child FLO card, e.g. the value of Index is 0 the first time the child FLO runs, 1 the second time, 2 the third time, etc. After you are done writing the child FLO, remember to turn it on.

  • Return

    Ends a FLO and returns values to the caller of the FLO.

    Input Fields

    This card has no default input fields. Input fields are created by supplying manual input or dragging-and-dropping output fields from other cards.

    Output Fields

    None

    Note: Return behaves differently when inside a If/ElseIf or If/Error block. Think of these blocks as anonymous child FLOs – and just as when you call a child FLO, a Return returns you to the parent. So, a Return inside one of these block proceeds to the step immediately after the container. Use a Continue If after the If/ElseIf block to stop a FLO under normal conditions. Or, you can use Return Error or Return Error If instead, but it will generate an error when it halts the FLO.

  • Return Raw

    Returns data to the caller, with full control over the HTTP Response.  

    This function is an advanced version of Return - it is less convenient to use but allows for full control over the HTTP Response.  

    Using this function you can do the following:

    • Produce an API that returns XML:  Use the XML Build function to create an XML string containing your response, then drag the output to the body input of Return Raw.
    • Produce an API that returns a JSON list:  Use the JSON Stringify function to create a stringified representation of your list response, then drag the output to the body input of Return Raw.
    • Produce an API that returns an object with dynamic keys:  The Return function makes you define the keys of your response at design time.  Using the Return Raw function, you can use the Object functions to build a response object, then use JSON Stringify to create a stringified version of the object, then drag the output to the body input of Return Raw
    • Set the status code for the response:  Return will always return 200.  Use Return Raw to set the status code to one of the valid values (200, or 400-600).
    • Set the http headers of the response:  Use the Object functions to create an object representing your desired header.  For example if the headers object is { "Content-Type": "application/xml" } then the header string for the response would be “Content-Type: application/xml”.  The designer will merge those headers with the headers produced by our API service.

    Input Fields

    • statusCode (Number): the status code to return to the caller.  Valid values are:  200, 400-600.
    • headers (Object): An object representing the headers for the response.  Each key of the header will be parsed into a header string as ”key: value”, i.e. “Content-Type: text/plain”
    • body (Text): The http response body.

    Output Fields

    No output fields.

  • Wait For

    Pause the FLO and wait for a specified amount of time before resuming the FLO execution. NOTE: The minimum amount of time you can wait is 1 second, and the maximum is one year.

    Input Fields

    • delay: the amount of time to wait
    • unit: the unit of time

    Output Fields

    No output fields

  • Wait Until

    Pause the FLO and wait until a specific date & time to continue executing the FLO.   NOTE: The minimum amount of time you can wait is 1 second, and the maximum is one year.

    Input Fields

    • date & time: the date and time to wait until

    Output Fields

    No output fields.