Call a web service

Use the Call a web service actionA tool for building the processes, logic, and direction within workflows. to make HTTP requests and API calls. You can output the response content, response headers, and response status code as variables. The response content is returned in JSON format.

For example, let's say you have a change management workflow for business processes, and those business processes also have corresponding workflows. When a business process (and therefore a workflow for that business process) requires a change, someone fills a Nintex form to request the change which kicks off the change management workflow.

When a change to the business process is approved in the change management workflow, the Call a web service action makes a HTTP post request to the Nintex platform API, which deactivates the workflow for the business process which requires the change. The workflow designer can then make the required changes to the workflow without any new instances of the workflow running. See Step-by-step example: Make an HTTP Post request to Nintex Workflow Cloud to deactivate a workflow

Another example to use the Call a web service action is to retrieve current weather information of a specific city by making an API call to a third-party API platform such as OpenWeatherMap. See Step-by-step example: Make an API call to the OpenWeatherMap API to retrieve weather information.

Before you start 

Configure the Call a web service action

In the Designer page:

  1. Click the Integration action group in the action toolbox.

    or

    Find actions by browsing action groups or by typing an action name or function in the Search field at the top of the action toolbox.

  2. Drag the Call a web service action to the point in the workflow when you want to call a web service.
  3. Click the Call a web service action to open the configuration panel.
  4. In URL, type your request URL or select a variable that holds your request URL.
  5. Select a Request type.
  6. In Request headers, type your request headers or insert a variable that stores the headers of your HTTP request.
  7. In Request content, type your request content or insert a variable that stores the content of your HTTP request.
  8. Select or create variables for Response content, Response headers, and Response status code. You can use these variables later in your workflow.
  9. Note: You can use the Response content variable in a Query JSON action to extract information from the response content. See Query JSON for more information.

For more information on the fields and buttons, see Call a web service action fields and selections.