Export OpenAPI Definitions v2

Export OpenAPI for published Workflows that expose HTTP receive and respond contracts.

  1. Open the Workflows screen.
  2. Select one or more HTTP Workflows.
  3. Open the download menu.
  4. Click Download OpenAPI definition.
  5. Choose the Environment and OpenAPI version.

You can also request the API-key-filtered definition from GET https://{environment-hostname}/openapi.yml?runtimeVersion=2.

Improve the definition

  • Add a useful Workflow description.
  • Configure the HTTP method and route on the receive Step.
  • Provide representative request body and request header definitions.
  • Add one matching root-level HTTP respond Step.
  • Configure explicit response status, body, and headers.

The Workflow must be published before its current contract can appear. OpenAPI export does not publish, enable, or authorize the Workflow.

See also

See OpenAPI Definitions via API, API, and Publish a Workflow as an HTTP Endpoint.