Send customers to HiFiveStar from any app (connection links)

Every app you connect on the Automate page gets its own connection link. Any app or script that can send a web request can use it to hand HiFiveStar a customer. HiFiveStar then asks that customer for a review on the schedule you set on the connection.

Get a connection link

In HiFiveStar, open Automate.
Click Connect on the app you use (Zapier, Make, or your own software), copy the connection link, and tick the box confirming you have permission to message these customers.
Switch the connection on when you are ready for real customers to be asked.

A connection link looks like https://app.hifivestar.com/api/hooks/<token>. Keep it private: anyone who has it can send you customers. Deleting the connection in Automate stops the link working.

Check a link

GET https://app.hifivestar.com/api/hooks/<token> checks a link without using it. Nothing is recorded.

200 and {"ok": true, "app": "zapier", "business": "Your business", "enabled": true}: the link works. enabled says whether the connection is switched on.
404 and {"error": "Unknown connection link"}: no connection has this link.

Send one customer

POST https://app.hifivestar.com/api/hooks/<token> with a JSON body, or a form, holding one customer:

{"name": "Taylor Reed", "phone": "+15550100190", "email": "[email protected]", "id": "job-1042"}

name: shown in the message, as in "Hi Taylor". first_name and last_name work too.
phone: for a text. A number without a country code is read as a US or Canadian number (an Australian one for Australian businesses).
email: for an email, or when there is no mobile number.
id (optional): your job, order or booking number. If the same number arrives again, the customer is not added twice.
test (optional): true checks your setup. HiFiveStar shows the test under Automate and messages nobody.

Each customer needs a phone number or an email. Field names are read without regard to capitals, and they can also sit inside a customer object.

What HiFiveStar answers

200 and {"ok": true}: received. HiFiveStar plans the review request.
200 and {"ok": true, "repeat": true}: that id was already received, so nothing changes.
200 and {"ok": true, "ignored": "<why>"}: received, and nobody is messaged. Tests answer this way, and so does a customer with no phone number or email.
404 and {"error": "Unknown connection link"}: no connection has this link.
413 and {"error": "Too large"}: the request is too large.

When the request goes out

The connection's own settings decide when: right away, 1, 2 or 4 hours later, or the next day, two days or a week later at 10am. They also decide how: by text, by email, or one with the other as a fallback. And they set how long before the same person can be asked again, from 30 to 365 days.

Texts only go out between 9am and 9pm in your time zone. A customer who has opted out, or who has already left a rating, is never asked.

Automations send review requests on the Pro plan and up. Any plan can connect a link and test it.

Help center