Reply to your Trustpilot reviews directly via Slack
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
app
screenshots Update screenshots Dec 13, 2017
.dockerignore
.editorconfig Moved to root Mar 23, 2017
.eslintrc
.gitignore
.travis.yml
Dockerfile Switch to npm, npm audit fix Jan 18, 2019
LICENSE.txt
README.md Switch to npm, npm audit fix Jan 18, 2019
docker-compose.yml
package-lock.json
package.json Switch to npm, npm audit fix Jan 18, 2019

README.md

slack-trustpilot

Build Status

Read and reply to your Trustpilot reviews directly via Slack. Integrate with Webhook Notifications to get your reviews posted automatically in public or private channels.

Trustpilot also provides a hosted version of this project through Trustpilot Labs.
Continue here if you prefer your own API integration or would like to customize it.

How does it work?

Once deployed and authorized on your Slack domain, the app creates a bot user and adds a new slash command which will enable you to ask for the latest review (e.g /trustpilot latest or /trustpilot 5 stars if you want to see a 5-star review). The latest unanswered review will then be displayed, along with a "Reply" button. If you want to reply, the app will create a dialog box where you can compose your reply and send it.

It's as easy as demonstrated by these screenshots!

How to set this up

Trustpilot Credentials

Make sure you have valid credentials to access the Trustpilot API, i.e. your Business Unit ID, API Key and API Secret. You will also need the login and password for your Business user on Trustpilot.

Slack App Credentials

You will have to create an app on your Slack domain. Once your app is created, go to "Basic Information" and grab your Client ID, Client Secret and Signing Secret.

Configuration

You should now have all the information to configure this app. Just clone this repo and edit the app/config.js file. The contents should be as follows:

module.exports = {
  // Minimal configuration needed
  // Use the below environment variables or put values directly between the quotes, e.g.
  // SLACK_CLIENT_ID: process.env.SLACK_CLIENT_ID || '<Your Slack Client ID>'
  SLACK_CLIENT_ID: process.env.SLACK_CLIENT_ID || '',
  SLACK_SECRET: process.env.SLACK_SECRET || '',
  SLACK_SIGNING_SECRET: process.env.SLACK_SIGNING_SECRET || '',
  API_KEY: process.env.API_KEY || '',
  API_SECRET: process.env.API_SECRET || '',
  BUSINESS_USER_NAME: process.env.BUSINESS_USER_NAME || '',
  BUSINESS_USER_PASS: process.env.BUSINESS_USER_PASS || '',
  BUSINESS_UNIT_ID: process.env.BUSINESS_UNIT_ID || ''

  //...
};

As you can see, it's also possible to define all your configuration as environment variables, if you prefer this.

Deploy this app somewhere

This is left as an exercise to the reader :). You can – and maybe should – also run this app in a Docker container. The included Dockerfile and docker-compose.yml should set you off to a good start.

Once your app is deployed, the following endpoints should be reachable:

  • https://<your.app.url>/login, where you will authorize your app for Slack
  • https://<your.app.url>/oauth, where Slack will redirect after authorizing your app
  • https://<your.app.url>/slack/receive, where Slack will send interactive messages.
  • https://<your.app.url>/incoming-webhooks/<your-slack-team-id>, where new reviews can be posted. Use this endpoint to setup Webhook Notifications.

Configure your app in Slack

  • In "App Credentials", the Redirect URI should point to the OAuth endpoint at the place where you deployed your app. This should look like https://<your.app.url>/oauth.
  • In "Bot Users", make sure to add a bot. Call it something nice, like trustpilot ;)
  • In "Interactive Messages", paste your receiving endpoint (which should look like https://<your.app.url>/slack/receive)
  • In "Slash Commands", create a new command (e.g /trustpilot) and point it to the same endpoint as above, https://<your.app.url>/slack/receive

You should now be able to authorize your app by visiting the login endpoint at https://<your.app.url>/login

Tests and development: running the app locally with localtunnel

If you don't want to deploy this app just yet, this repo comes with everything you need to run the code locally.

After running the obligatory npm install, start the app with:

npm run local

Wait for the localtunnel.me URL to appear in the log messages. This will allow Slack to bridge with your locally running app:

Tunnel started at http://[random].localtunnel.me

Follow the instructions in the "Configure your app in Slack" section above, using the localtunnel URL as your app's URL. Important! Change the protocol to https to make Slack happy :)

Finally, go to http://localhost:7142/login, or your localtunnel URL followed by /login, and authorize your app.