Developer Portal and API Reference

Where to find it

Open app.rivolq.com/developers. In development environments it links to interactive API docs and a ReDoc reference; in production, API reference access may be request-based. The portal includes API documentation links, an OAuth 2.0 quick start, a webhook event catalog, a scope catalog, rate-limit expectations, and a link to register OAuth apps.

OAuth quick start

1. 01Redirect the user to authorize with client_id, redirect_uri, response_type=code, requested scopes, state, and a PKCE challenge.
2. 02Exchange the authorization code for tokens at the token endpoint.
3. 03Call the API with the access token.

Use OAuth when the integration acts on behalf of a user and should respect their granted scopes.

Catalogs and rate limits

The event catalog lists webhook event names and descriptions. Scopes cover profile, work-order, asset, and report access; request only what you need. The platform expects 600 requests per minute per session, with X-RateLimit headers on responses. Read those headers and back off to avoid retry storms.