About this guide¶

Who this is for¶

You, if you're building software that integrates with Revento — whether that's a public app listed in the Revento catalog, an in-house tool for a single organization, or a one-off internal script.

It assumes you're comfortable with:

HTTP and JSON
OAuth 2.0 Authorization Code flow (you don't need to be an expert — we'll walk through the specifics, but you should have seen one before)
Running a small web service that can receive HTTP callbacks (for the OAuth redirect_uri and for webhooks)

Language-wise the examples in this guide are in JavaScript / Node, with a Python translation in the Code examples section. The contract is language-agnostic — anything that can speak HTTP and verify an HMAC will do.

What this guide covers¶

The conceptual model — what an integration is, what it can and can't do, how it relates to events, organizations, and participants.
The full OAuth flow for both installation tokens (server-to-server, organizer-authorized) and user tokens ("Login with Revento" for participants).
Every read API endpoint, with request shape, response shape, error codes, and pagination.
The webhook contract — every event type, payload schema, signature recipe, retry expectations.
Scopes, rate limits, errors, debugging.
Webview pages — when and how to embed UI inside the Revento app.
Sandbox usage and the path to production.

What this guide does NOT cover¶

Server-side implementation details. The contract you build against is HTTP + JSON + HMAC. Whatever runs on our side to serve it is irrelevant to your implementation.
Specific apps built on the framework. Apps that have their own setup flow on top of this framework (e.g. an integration that requires its own third-party OAuth in addition to Revento's) document their own flow separately.

Versioning¶

Two things version independently:

This guide — versioned in docs/changelog.md. Editorial improvements, new examples, restructured sections. Doesn't affect the contract.
The API — versioned via the Accept: application/vnd.revento.v1+json header. Breaking changes go in a new version and the previous version is supported for at least 6 months after sunset announcement. Today the only version is v1.

If something in the API contract changes in a way that affects you, you'll see it both in the changelog and in your developer console.

Feedback¶

The fastest way to give feedback on this guide:

Email support@revento.app. Anything counts — typos and ambiguity in the docs, "this didn't work the way the docs said it would," API bugs, missing endpoints, scope requests, rate-limit increases, anything else.

We read all of it.