Resources
OpenAPI
Download the RevoplyAI OpenAPI specification and the webhook signature test vectors.
- OpenAPI 3.1: the canonical contract. Today it describes the
flow trigger endpoint (
POST /hooks/{token}) and every webhook event underwebhooks. The REST API's operations are added when it is published. - OpenAPI 3.0: derived from the 3.1 file for tools that do not read 3.1 yet. It cannot hold webhooks, so it has none.
- Webhook signature test vectors: signed requests to test a verifier against; see Signatures.
The specification uses these extensions:
| Extension | Meaning |
|---|---|
x-revoply-plan | The plan an operation needs, such as Business. |
x-revoply-try-it | false where the reference offers no in-browser console. |
x-revoply-max-bytes | The largest request body accepted. |
x-extensible-enum | Values known today of a string that may gain more. Accept unknown values. |