Intercom
Introduction
Intercom is a Conversational Relationship Platform (CRP) that helps businesses build better customer relationships through personalized, messenger-based experiences across the customer journey. By integrating it with Botpress you can leverage AI to automate your customer support and sales processes.
Prerequisites
- An Intercom account (opens in a new tab)
- Administrator or Developer access to a Intercom workspace
Setting up the Intercom integration in Botpress
- Go to the Integration Hub (opens in a new tab) in Botpress Cloud (if you don't have the integration installed yet).
- Find and open the Intercom integration then click on the "Install to Bot" button, now go back to your bot settings.
The Intercom integration has the following settings:
- Enabled: Whether Botpress will communicate with Intercom
- Webhook URL: The URL for receiving data in Botpress
- Access Token: The access token for the Intercom app
- Admin Id: The admin id for the Intercom app
Setting up Intercom
In this tutorial we are going to be using a standard production workspace, but you can also create a Test workspace to test the integration before deploying it to production.
To do that, open the Settings of a production workspace, go to the General settings tab and look for the "Enable a test workspace" and click "Save". Now you just need to use this workspace in the steps below. Learn more about test workspace here (opens in a new tab).
After verifying that the integration works, you will need to repeat the steps below using the production workspace! Don't create the app again, just go to the app settings (Test and publish > Your workspaces) and install it to the production workspace.
Creating an App
In order to communicate with Botpress, you need to create a developer app in Intercom.
- Go to the Developer Hub (opens in a new tab) in Intercom then click "Your Apps"
- Click "New App", give it a name like
Botpress connector
, then select the desired workspace and click "Create App" - You will be redirected to the app's Authentication settings page. Copy the Access Token and paste it in the Botpress integration settings.
Getting the Admin Id
- Open Intercom and hover over your avatar in the bottom left corner, then click your avatar again to see your profile
- Copy the last number in the URL (as shown below), this is your Admin Id. Paste it in the Botpress integration settings
Setting up the Webhook
- Copy the Webhook URL provided in the Botpress integration settings
- Go back to the Intercom app settings and open the "Webhooks" tab
- Paste the URL in the "Endpoint URL" section
- Click the "Select a topic" dropdown under the "Topics" section, a list is going to show up
- Search for
user
and and click the optionsconversation.user.created
andconversation.user.replied
. Now exit the list and a "Topic" section should appear with the selected topics. Click "Save" to finalize the webhook configuration
Adding a Default conversation Assignee
- Go back to the Intercom app settings and open the "Inbox" tab
- Click "Inbox settings" then "Workload management"
- In the "Default assignee" section select yourself or another user to receive the conversations from the bot (it needs to be the same user as the Admin Id)
Finalizing the configuration
Now you just need to Enable the integration in the Botpress settings and click "Save configuration".
That's it, you may now start chatting with your bot on Intercom!