Skip to main content
The Call External API rule lets you interact with APIs configured in the API Connection Manager. You can map question answers in the form to the request that is sent (parameters, headers, body, and the authentication method) and map the response back to questions within the form. Call External API rule configuration

​
Title

The first part of the business rule lets you define a title for your rule and select the event on which it operates. The default title is the standard FlowForma rule name; change it by deleting the text and entering your own. In the event field you determine when the rule is executed. For a flow this can occur when the form is loaded, started, or completed. For a step this can occur when the step is started, saved, or completed. For questions it can occur when the question is updated.

​
Rule condition(s)

The second part of the business rule lets you set conditions. These are not required, but if entered they control when the rule is executed in relation to other items in the form.

​
Rule actions

  • Select API: select the API you want to use from the connections created in the API Connection Manager.
  • Select request: once an API is selected, choose the request you want to make with this rule.
Selecting the API request Once an API and request are selected, additional options to configure the request appear:
  • Params: enter values to send as parameters with the API request, using the value entered in the API Connection Manager, free text, or a mapping to a question in the form.
  • Headers: enter values to use as headers with the API request, using the value from the API Connection Manager, free text, or a mapping to a question.
  • Body: enter values to use in the body of the API request, using the value from the API Connection Manager, free text, or a mapping to a question.
  • Custom body: define a custom format for the body of the API request, which can reuse the API body defined in API connections.
  • Response: map values returned in the response to the API request.
Mapping the API response to questions Select the node in the response body section, use the question picker in the “map body value to” section to select the question you want the response value mapped to, and click the + icon. The Mappings section displays all current mappings, with a delete icon to remove any that aren’t needed.
  • Authentication: enter values to send for authentication with the API request, using the value from the API Connection Manager, free text, or a mapping to a question.
  • Stop execution: if stop execution is enabled and this rule is executed, no other rules are executed.
  • Enabled: rules aren’t saved to a list like questions and steps are, so if you want to stop a rule executing without deleting it, toggle this option to enable or disable the rule.
  • Enable audit: if checked, a record is added to the audit trail when this rule is executed. This option is available when the Compliance feature pack is activated.