Skip to main content
Version: 6.1

Invoke OpenAPI

The Invoke OpenAPI makes a request to a configured OpenAPI endpoint and returns the response as a DataObject that can be used in the rest of the workflow.

OpenAPI Service​

Select an existing OpenAPI service from the dropdown, or click New Configuration to create one inline. See Open API Service for setup instructions.

Select Path​

Once a service is selected, choose the API endpoint path to call from the Select Path dropdown. The available paths are populated from the service's OpenAPI specification if one was uploaded, or can be entered manually.

Headers​

Click the + button next to Headers to add custom HTTP request headers. Each header entry has:

  • Key: The header name (e.g., api_key).
  • Value: The header value. You can also use properties here to supply the value as a dynamic expression.

Body Type​

Select the format of the request body for methods that send data: Form-Data or RAW (JSON). You can set to None if the method does not require a body.

Path Parameters​

Click the + button next to Path Parameters to add values for URL path variables — the named segments enclosed in braces in the path, such as {petId} in /pet/{petId}. Each entry has:

  • Name: The path variable name as it appears in the path (e.g., petId).
  • Value: The value to substitute. You can also use properties here to supply the value as a dynamic expression.

Query Parameters​

Click the + button next to Query Parameters to add URL query string parameters that are appended to the request URL. Each entry follows the same Name / Value pattern as path parameters.

The screenshot below shows a configured node calling the /pet/{petId} path of a Petstore service, with an api_key header and a petId path parameter:

Properties​

The Properties tab lists the node's runtime properties. The number in parentheses indicates how many properties are currently defined. These properties can be read or set by other nodes and scripts in the workflow.

View Output​

Click View Output at the bottom of the settings panel to preview the API response returned by the configured call before saving.