Reviews API
Drive invitations and reviews from your own backend
Create a confidential OAuth client with the scopes it needs and automate invitations, widgets and review workflows server to server. Everything the business panel does is available to your own code.
Free to use for nowAll features includedSet up in 2 minutesWhat moves between the two systems
WebVouchInvitations, templates, widgets and reviews- What starts it
- Your own code calls it.
- What WebVouch receives
- Whatever the request carries: invitations, widget configuration, review queries.
- What goes back to API
- The response the call asked for. Pair it with webhooks when you also need telling about new reviews.
What the API integration does
Create named server side OAuth clients with scoped permissions.
Automate invitation, widget and review workflows from your systems.
Work from the public OpenAPI description and server side examples.
How to set it up
3 steps, in the order you do them. The connection lives in your business panel.
- 1
Create a client
Add a confidential OAuth client in the business panel, name it after the system that will use it, and keep the credentials on your server.
- 2
Grant only the scopes you need
Scope each client to the work it does. A service that only sends invitations has no reason to read moderation data.
- 3
Call the API
Follow the public OpenAPI description. Pair it with webhooks when you also need to react to reviews as they arrive.
When API is the right choice
Pick the API when no plugin can see the sale, for example a phone order, a second sales channel, or a booking a person confirms. For a plain shop checkout the store integration is less work and needs no maintenance.
The Reviews API, in depth
Three things worth knowing before you write the first call. Each of them is also true of the reference you can read without an account.
- 01
Server to server, with scoped clients
Authentication is a confidential OAuth client created in the business panel. It is a server side credential, so it never belongs in a browser or a mobile app. Each client is scoped to the work it does: a service that only sends invitations gets invitations and nothing else, and it cannot read the moderation data it was never granted.
- 02
What you can automate
Twenty-eight endpoints cover invitations, templates, widgets and reviews, so everything the business panel does is available to your own code. The public OpenAPI description is machine-readable, which means you can generate a typed client rather than hand-write one, and the quick start walks through the first call before you sign up for anything.
- 03
When the API beats a plugin
A store plugin sees orders in that store and nothing else. The API covers what the store never sees: a phone order, a second sales channel, a booking a person confirms by hand. Run it alongside a plugin rather than instead of one, and pair it with webhooks when your system also needs telling as new reviews arrive.
Read the API integration before you install it
Links leave the site and open in a new tab.
API integration questions
Through confidential OAuth clients created in the business panel. They are server side credentials, so they never belong in a browser or a mobile app.
Integration details last updated
