Skip to main content

OpenAPI action

Calls an operation described by an OpenAPI specification. In the action picker it is OpenAPI, under General Actions. It needs no connection of its own.

Fields

FieldRequiredDescription
Spec URLYesThe URL of the OpenAPI specification. It is fetched and checked as you enter it, and a note reports what was found.
OperationYesThe operation to call, chosen from the operations that specification defines. The picker names each one with its method and path.
Dry Run: Outbound HTTPNoOn the Advanced tab. Overrides the default policy for what this step actually sends during a dry run. Leave it unset to inherit that default.

The form builds itself

Pick an operation and the form grows a field for each of that operation's path, query, and header parameters, and for each property of its request body. A parameter's own description from the specification becomes the field's note, a parameter with a fixed set of values becomes a picker rather than a text box, and a required parameter is marked required.

Most of these fields accept variables, so the call can be built from the trigger's data and earlier results.

What a dry run sends

PolicyWhat leaves the system
NoneNothing. Every call is logged with its method and URL, and the step returns its test output instead of a real response.
Safe Methods OnlyRead-only requests are sent for real, so later steps see live data. Anything that writes is logged and skipped. An endpoint is free to break that convention—choose None if you cannot vouch for the endpoints being called.
All MethodsEverything, including the requests that write. A dry run rehearses nothing about outbound calls under this policy—choose it only when the endpoints are themselves test targets.

With no policy set on the step and none set as the default, Safe Methods Only is what applies.

Output

The operation's response, shaped by the response schema the specification defines for it—so later steps can reference its fields by name.

Was this page helpful?

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.