Skip to main content

OpenAPI Spec

You can download the published OpenAPI JSON for v1 directly from this docs site:

Need Swagger 2.0 for Power Automate or other legacy tooling?

Use the specification​

The OpenAPI 3 definition includes documented read operations, supported writes and grouped summary endpoints. Use it to inspect parameters and response schemas, generate a client or import requests into your API tooling. Supply your own API key through that tool's authentication settings; the definition contains no credentials.

Webhook payload definitions are published in the x-webhooks extension. Some tools do not render this extension, so use the webhook reference for event availability, signature verification and delivery behaviour.

The Swagger 2.0 export is intended for tools such as Power Automate that require that format. Its managed trigger definitions are generated for the supported automation events; use the event catalogue to check broader webhook availability. Keep a copy of the definition used to validate your integration release and review the Changelog for updates.