Trigger review requests from any system.
A REST API and signed webhooks, included on every plan. Tell Praisly when a job, visit or move-in happens; it handles timing, quiet hours, cooldowns and opt-outs, then sends the request by email or text, or lines it up for a one-tap WhatsApp send. Read reviews, feedback and stats back out.
Quickstart
- Create a key in Settings, API and webhooks. It is shown once and stored only as a fingerprint.
- Switch on a rule in Automations, for example “After a job is completed, 3 hours later”.
- Send an event when the job is done:
curl -X POST https://praisly.io/api/v1/events \
-H "Authorization: Bearer prk_live_..." \
-H "Content-Type: application/json" \
-d '{
"type": "job.completed",
"external_id": "job-10442",
"customer": { "name": "Jordan Lee", "phone": "+13125550142" }
}'Praisly answers with what it scheduled and when:
{
"event_id": "1b6c...",
"customer_id": "9f30...",
"duplicate": false,
"scheduled": [{ "request_id": "c2d1...", "scheduled_for": "2026-11-16T19:00:00.000Z" }],
"note": null
}Events are idempotent on type + external_id, so retries never ask a customer twice. Rate limit: 120 requests a minute per key. Errors come back as { "error": { "code", "message" } }.
No code? Use the webhook URL
Every workspace gets one secret URL. Point a Zapier, Make, n8n or Power Automate step at it, or any system that can send a webhook. Field names are flexible: name or first and last name, email, phone or mobile, and an event id. Arrays of up to 100 events are accepted.
POST https://praisly.io/api/hooks/<your secret token>
Content-Type: application/json
{ "event": "work_order.completed",
"work_order_id": "WO-5531",
"tenant_name": "Sam Rivera",
"tenant_email": "[email protected]",
"mobile": "+13125550199" }Endpoints
| post | /api/v1/events Send an event (the main automation trigger) Tell Praisly something happened: a visit, a finished job, a completed maintenance request, a move-in. Praisly creates or updates the customer and, when an automation rule matches, schedules a review request (respecting quiet hours, cooldowns and opt-outs). Idempotent on (type, external_id). |
| get | /api/v1/customers List customers |
| post | /api/v1/customers Create or update a customer Matches on external_id, then email, then phone. Sends nothing. |
| get | /api/v1/review-requests List review requests |
| post | /api/v1/review-requests Get a personal tracked review link For sending from your own SMS, email or app. Opens and clicks are tracked in Praisly and sent to your webhooks. |
| get | /api/v1/reviews List reviews |
| post | /api/v1/reviews Push a review in Bring reviews from another system. De-duplicated by external_id. |
| get | /api/v1/reviews/{id} Get one review with its analysis and reply |
| get | /api/v1/feedback List private feedback |
| get | /api/v1/stats Rating, volume, replies and request funnel for a location |
Webhooks out
Add an https endpoint and pick events: review.created, feedback.created, customer.created, request.sent, request.opened, request.clicked, dispute.updated. Each delivery is a JSON body with id, event, created_at and data, signed with your endpoint secret. Failed deliveries retry at 1, 5 and 30 minutes, then 2 and 6 hours.
import crypto from "node:crypto";
// header: Praisly-Signature: t=1763300000,v1=<hex>
export function verify(rawBody, header, secret) {
const parts = Object.fromEntries(header.split(",").map((p) => p.split("=")));
const expected = crypto
.createHmac("sha256", secret)
.update(`${parts.t}.${rawBody}`)
.digest("hex");
const fresh = Math.abs(Date.now() / 1000 - Number(parts.t)) < 300;
return fresh && crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(parts.v1));
}Rules the API cannot override
- Every customer gets the same request. There is no field to filter by sentiment, and the review page has no rating gate.
- Customers who opted out are never contacted again, whatever the API is told.
- Quiet hours and the per-customer cooldown apply to every automated request.
See also: integrations and the compliance brief.