Downloading the OpenAPI document of a project

This section details how to export a project as an OpenAPI document.

You can export your projects as an OpenAPI specification document. OpenAPI documents are machine-readable specification of web services.

When you export a project, you get an OpenAPI document that specifies all available web services that the project exposes for consumption by other systems. You can feed other systems that can interprete OpenAPI specifications to integrate them with the public APIs exposed by your projects.

Procedure

The following procedure details how to export your projects:

  1. On the left menu, click on Projects.
  2. Click on the desired project.
  3. Click the Download OpenAPI button.

What to do next

You can use this OpenAPI specification document to feed systems that can interpret this document, thus integrating the system with these public Bots APIs.

If you are going to add callback URLs to the specification by using the callbackUrl parameter, you need to add the domains or IP addresses that the URLs target to the tenant's allowlist. See Callback URLs for details about callback urls.