Our Mattermost integration allows you to respond to messages from your customers directly from your self-hosted Mattermost instance.
This page will walk you through setting up the integration at https://app.papercups.io/integrations
All the API tokens used in this guide have been revoked and are no longer valid. Please keep all your API tokens a secret!
On the Integrations page at https://app.papercups.io/integrations, find Reply from Mattermost and click the "Connect" button:
A modal should pop up that looks like this:
First, you'll need to fill in your Mattermost URL.
Your Mattermost URL is simply the URL at which your Mattermost instance is hosted. (If you don't already have Mattermost and want to try it, the easiest way to get your own instance set up is by deploying to Heroku: https://github.com/mattermost/mattermost-server#deploy-on-heroku)
For example, the URL we use for our Mattermost demo would be: https://papercups-mattermost-demo.herokuapp.com
Fill in your Mattermost URL here:
In order to get a bot token for Papercups, you may need to first enable bot accounts in your settings.
To enable bot accounts, you'll need to navigate to
Menu > System Console > Integrations > Bot Accounts.
First, open the menu and navigate to the System Console:
Then, navigate to the Bot Accounts subsection under the Integrations section.
Set Enable Bot Account Creation to true and hit the Save button at the bottom.
Next, set up your bot account by navigating to
Menu > Integrations > Bot Accounts > Add Bot Account.
First, open the menu and navigate to the Integrations:
On the Integrations page, navigate to Bot Accounts:
Click the "Add Bot Account" button:
Then, enter the following information in the Add Bot Account form:
Bot account details:
papercups(name this whatever you want)
- Display Name:
Papercups(name this whatever you want)
Click "Create Bot Account". That should lead you to this page:
Take note of the Token. This is the bot token which you should paste into Papercups:
If your bot token is working properly, you should now be able to select the channel from which you would like to reply to messages from Papercups.
As a best practice, it's good to set up a channel dedicated to responding to messages and nothing else.
In order to reply to messages directly from Mattermost, you'll need to set up an outgoing webhook.
To do this, navigate to
Menu > Integrations > Outgoing Webhooks > Add Outgoing Webhook
Once again, open the menu and navigate to the Integrations:
On the Integrations page, navigate to Outgoing Webhooks:
If you don't see this option, you may need to enable outgoing webhooks.
Click the "Add Outgoing Webhook" button:
Then, enter the following information in the form:
Outgoing webhook details:
Webhook events for the Papercups integration
- Content Type:
- Channel: Should match the channel you chose above (important!)
- Callback URLs:
https://app.papercups.io/api/mattermost/webhookor REPLACE WITH YOUR SELF-HOSTED URL (important!)
Click Save. After creating the new outgoing webhook, take note of the Token.
Finally, copy the token into the Papercups UI:
If you don't see an option for outgoing webhooks, you may need to enable it.
You can do this by navigating to
Menu > System Console > Integrations > Integrations Management and setting Enable Outgoing Webhooks set to true.
The easiest way to test that everything is working is by going to the Getting Started page at https://app.papercups.io/account/getting-started
From here, you can test sending messages through the chat widget to verify that they show up in your Mattermost channel.
In order to reply from Mattermost, simply reply to the message in a thread.