ReviewBot

Webhook API Reference

Each business gets one webhook URL (found on their Webhook page after logging in). POST a JSON body to it whenever a transaction completes, and ReviewBot handles templating, deduplication, and sending.

Endpoint

POST https://<your-domain>/api/webhook/<your-token>
Content-Type: application/json

Minimal body

{
  "name": "Jane Doe",
  "email": "jane@example.com"
}

Also accepted (auto-detected)

We check several common field names/shapes so you can usually point a platform's native webhook straight at us without any transformation step:

Responses

StatusMeaning
200 sentReview request email sent (or logged, in dev mode).
200 blocked_duplicateThis customer already received a review request — nothing sent.
400Body wasn't valid JSON, or no email could be found in it.
403This account is suspended.
404Unknown webhook token — check the URL, or it may have been regenerated.
429Too many requests in a short window — back off and retry.

Template tags

Use these in your email template (edited from your dashboard): {first_name}, {business_name}, {review_link}.