Webhooks
Signed events: review.created, review.updated, review.removed, reply.created, invitation.sent, invitation.completed, score.changed, proof.requested.
Developer API
Build on Proofwell with a simple REST API
Read reviews and your ProofScore, reply, create invitations from your own systems and get webhooks the moment something happens.
✓ API and webhooks are included from Pro
curl "https://api.proofwell.io/v1/reviews?limit=10" \
-H "Authorization: Bearer $PROOFWELL_KEY"
Endpoints
What you can do
JSON over HTTPS, versioned, with clear errors and cursor pagination.
GET
/v1/reviewsList and filter reviewsGET
/v1/reviews/{id}One review with its replies and proof badgePOST
/v1/reviews/{id}/repliesReply to a reviewGET
/v1/businesses/{id}/scoreYour ProofScore and rating breakdownPOST
/v1/invitationsCreate a review invitationGET
/v1/productsYour product cataloguePOST
/v1/webhooksSubscribe to eventsBuilt for developers
Everything you need
API keys and scopes
Keys with only the permissions they need (7 scopes), an expiry date, IP allowlists, and revoke any time.
Fair rate limits
10 requests a second and 1,00,000 a month on Pro, with clear headers so you know where you stand.
OAuth 2.0
Client credentials tokens for server-to-server apps, as well as API keys.
OpenAPI
A machine-readable description of every endpoint, plus code in cURL, Node.js, Python and PHP.
Status and changelog
A live status page and a changelog of every API change.
Questions
About the API
Which plan includes the API?
Pro and Enterprise. Keys are created in your account under Settings, Developers.
Can I create reviews through the API?
No. Reviews come only from customers. You can create invitations, which customers choose to answer, and reply to reviews.
Is there a limit on requests?
Yes. On Pro: 10 requests a second and 1,00,000 a month; Enterprise gets 10,00,000 a month. Your limits are shown in the response headers.