Admin Site
      Back to home
      1. OmniByte Self-Help
      2. FormsPro
      3. Admin Site

      Creating an HTTP Request Form Action Type

      How to use an HTTP Request form action type

      Form actions are processes that are triggered when responses are made on a form. An HTTP Request form action type uses a URL to perform the action and/or retrieve information. If you are unfamiliar with information in this procedure, contact your IT department. 
      1. Open the form for which you want to add a form action.
      2. Choose (Form Settings), then scroll to the right and click the Form Actions tab.
      3. Click (Add button) to open the Create Form Action window.
      4. Choose HTTP Request as the form action type, then name your form action. The form action is the name for the set of information you’re triggering. Because you can create multiple actions for each form, use a name that will help you identify the information in the action. For example, let's say your techs need current weather information before they can start working on a form. You can set up a form action to retrieve the weather information.
      5. If the endpoint you are calling is secured through a token, in the Data Source for Authentication field, select the data source that you configured in the Data Connection window. The authorization will be called to secure a token prior to calling the request URL. If you have a static token, or do not require authorization to the endpoint, leave this field blank.
      6. Select the request type. Consult the documentation for your endpoint for guidance on which request type should be used. Request types include:
        -Select Get to read/retrieve a resource.
        -Select Post to send data to a server to create or update a resource.
        -Select Put to send or replace data to a server to create or update a resource.
        -Select Patch to apply partial modifications to a resource.
        -Select Delete to delete a resource from the server.
      7. Enter the request URL. This is the endpoint that is called to perform the form action. You can include a merge field in this URL too, if applicable.
      8. If applicable, enter the request header and value to provide additional information about the request. 
      9. If applicable, enter the request content JSON or XML, then select the fields you want to include for the form action. 
      10. Enter the response example.
      11. Once you have the fields you want selected, click Preview to open a Preview window. Select the form submission to view a preview of the form action.
      12. Click Save, then click OK to close the Form Settings window.
      13. An Action button can now be added to your form that will execute the action.
      14. Click (Save button) on your form to save the form action.
      15. Click (Preview button) to test the form action. In the following example, once the Update Current Weather Conditions action button is clicked the Windspeed and Temperature fields populate, and the form can be completed. Keep in mind data may run and get updated when using the Preview window. We recommend you use the Preview window in a test environment in these circumstances.
      16. Verify the form action was executed successfully using the Form Actions Log.