Save a Chat Widget Transcript to a Hubspot CRM Contact Using Webhooks

This tutorial will explore how to make a chat widget that connects to the Hubspot CRM to (1) create or update a Hubspot CRM Contact with the user’s info, and (2) save chat logs in Hubspot. We’ll use the versatile Stream Chat client and its webhooks to accomplish this. The steps provided here will help you learn how to leverage webhooks to interact with your Hubspot CRM, based on any events within your chat widget.

Overview:

Open a free Stream account and configure an API key
Configure a Hubspot CRM account to connect to the Hubspot API
Build a backend that
1. Creates or updates the user’s info to a Hubspot CRM Contact
2. Starts a chat widget using Stream
3. Opens a private chat channel for the user and a support representative
4. Sends data back to the frontend for the user to join the chat channel
5. Logs all messages in the chat channel to the Hubspot CRM using web hooks

The code for this app can be found in the [Git Repo here](https://github.com/isaidspaghetti/stream-hubspot-chat-transcript

Read this tutorial if you want to...

Learn how to use webhooks
Build a support/sales style chat widget
Create Hubspot contacts and message logs based on your chat widget
Create Hubspot and Stream accounts and get API Keys
Set up a frontend/backend Stream Chat app
Create a Chat Widget that automatically saves the chat log in Hubspot CRM (using Stream Chat)
Set up a private, Frontend/Backend Stream Chat

These topics will be covered using Express JS and React, but the methodologies can be ported to most languages.

What's not covered

This tutorial focuses on the mechanics of setting up the backend of a chat widget to connect to and update HubSpot. Specifics on creating the React frontend will not be the priority. help with this
How to use the dotenv library
The GitHub repo for this project includes a fully functional registration form and frontend Stream chat, but not every aspect will be covered in depth.

STEP 1: Account set ups

To get up and running right off the bat, perform the following (instructions below):

Clone the git repo
Set up a free Stream Account, configure an API Key and Secret
Configure your HubSpot API Key
Set chat_transcript as a custom contact property field in HubSpot
Add your unique keys to a .env file

Set-up your Stream account

Sign up for a Stream Trial.
Then to generate a Stream API Key and API Secret, navigate to your Stream.io Dashboard.

Then click on "Create App", and complete the form like in the following screenshot.

Give your app a name, select "Development" and click "Submit".

Stream will generate a Key and Secret for your app. You need to copy these into your .env file as well.

Set up a free HubSpot Account and configure an API Key there, as well

Set-up your HubSpot account

Create your account at Hubspot and complete the registration form.
Once you are logged into the Hubspot Dashboard, go to Settings in the upper-right corner

Navigate to Integrations > API Key, and create a key. If you're a robot, stop here. You've gone too far...

Copy the Hubspot API key and paste it in the .env

Your Hubspot Account can now be accessed through this API key.

Create a custom HubSpot property for a chat transcript

To save the chat transcript, we will use a custom property field in HubSpot. Here's how to add a custom property to your HubSpot CRM:

Navigate to your contacts:

Click the 'Actions' drop down menu, then 'Edit Properties':

Click the 'Create Property' button and add whatever type of custom fields you'd like to use.

Set your local environment variables

Add your API keys and secret to the file titled .env.example

//backend/.env
NODE_ENV=development
PORT=8080

STREAM_API_KEY= your stream api key here
STREAM_API_SECRET= your stream api secret here
HUBSPOT_API_KEY=your hubspot api key here

Rename the file .env.example to .env

STEP 2: Webhook Setup

What are web hooks?

If you’re new to webhooks, here’s a quick explanation of how they work. Webhooks are like a push email notifications between apps. In the days of AOL 6.0 et al., you had to log in to see if you had any new emails. Push notifications came long and we got the luxury of receiving an alert whenever we received a new email. A webhook is like the alert that gets sent to your phone to let you know something happened at your email address. Stream’s WebHooks can alert your app about anything that happens in any Stream Chat. This app uses Stream’s webhooks to ‘push’ new messages to our backend, and our backend can then send those messages to the Hubspot CRM API.

A Webhook might look like this:

![] (images/webhook-example.png)

Where the first portion is the specific URL which will receive a POST from the webhook, and the information after the ? is the payload

Setting up a Stream webhook

Stream offers a lot of depth and versatility from its webhooks. To start using them, let's first tell the Stream know where to send a webhook. Stream’s webhooks require a publicly routable URL to communicate with (a common trait for many applications). This project runs off a local host, so we need to somehow make our local host address accessible. We’ll use the Ngrok App (free for the needs of this app) to create a secure, temporarily public address for our backend. If you already have a public URL running, you can skip the Ngrok steps and just set up an endpoint URL there.

Quick detour: How Ngrok works

A very brief overview of how the Ngrok app works:

Ngrok sets up a random, public URL on its servers. This URL can receive HTTP requests (eg: webhooks).
Ngrok opens an SSH connection with your local machine.
Requests to the Ngrok public URL get translated into an SSH command that is sent to your machine.
Run your backend as you normally would, through any port (eg: localhost:8080).
Ngrok recieves the SSH request, translates it back to an http request, and sends it to your app at port 8080.
The local app runs as it normally would, sending a response to port 8080.
Ngrok receives responses from your app, and sends the responses back to the Ngrok server via SSH

In the end, your IP address is never made public, and you can test out your webhooks without going through production deployment.

Ngrok setup

Register for a free ngrok account and download the software. *if you prefer to use Homebrew to install Ngrok, use the following terminal command: Brew cask install ngrok.
Once installed, connect your account using the authtoken provided by ngrok at the same link as above. Just run ngrok authtoken your_token_goes_here in the terminal.
To start ngrok, use the terminal command: ngrok http 8080: which tells ngrok to ‘serve’ whatever you are serving locally at http://localhost:8080.
The terminal opens the ngrok app (screenshot below), and shows the public URLs.

Now, whatever is hosted at localhost:8080 can receive http requests at this URL. (The URL boxed in red is the publically available URL).

Create a backend webhook handler

The backend of our app needs a handler for webhooks. This is initialized on lines 10 and 20 of api.js:

//backend/api.js:10
const webHookRouter = require('./routes/index')

And

//backend/api.js:20
api.use('/webhooks', webHookRouter)

The code snippets above tell Express to use the file //backend/routes/index.js anytime an HTTP request is made to the route /webhooks. Next, we need to let Stream know about this webhook URL.

Configure your public webook URL in Stream

Use the following steps to register your Ngrok (or other public URL) with the Stream API:

Navigate to getstream.io and click the Dashboard button on the upper right:

Once in the dashboard, click your app name:

Next, from the navbar select the chat dropdown and select Chat Overview

Scroll down to the Chat Events box. Select the following options: Webhook: active, Disable Auth Checks, and Disable Permissions Checks. (Note that these options are important to consider using if using this app in a production environment). Then, add your public ngrok url and /webhooks to the webhook URL textbox. Save your settings.

The Stream API will now send a POST to the URL in the textbox anytime an event takes places in your Stream App, with details about the event. So the next step is to accept that webhook in our app's backend

Registration endpoint

Initialization

The backend file backend/routes/index.js is the core of the backend of this app. Let's take a peek at how this file is initiated:

//backend/routes/index.js:1
const express = require('express');
const router = express.Router();
const StreamChat = require('stream-chat');
const { default: Axios } = require('axios');
require('dotenv').config();

const apiKey = process.env.STREAM_API_KEY;
const apiSecret = process.env.STREAM_API_SECRET;
const hubspotKey = process.env.HUBSPOT_API_KEY

The stream-chat library is the all-in-one chat creator, which handles all the heavy lifting of for our chat portion of the app. Axios will be used to perform external HTTP requests to HubSpot. dotenv allows us to call our environment variables from the .env file, and keep their values hidden from a browser.

There will be several methods in this file that will utilize our access keys, so they are declared as globals early on.

User registration: starting a chat

index.js contains two endpoints: one for registering a user, and one for receiving webhooks. The registration endpoint is responsible for:

Accepting the user's frontend form input
Creating a HubSpot customer entry
Initializing a Stream chat client
Registering the user and support admin with the client
Opening a Stream chat channel

Here's the primary registration endpoint, which will will be breaking down step by step.

//backend/routes/index.js:39
router.post('/registrations', async (req, res, next) => {
  try {
    const firstName = req.body.firstName.replace(/\s/g, '_');
    const lastName = req.body.lastName.replace(/\s/g, '_');
    const email = req.body.email.toLowerCase()
    const hubspotCustomerId = await createHubspotContact(firstName, lastName, email)

    const client = new StreamChat.StreamChat(apiKey, apiSecret);

    [customer, supporter] = createUsers(firstName, lastName)

    await client.upsertUsers([
      customer,
      supporter
    ]);

    const channel = client.channel('messaging', hubspotCustomerId, {
      members: [customer.id, supporter.id],
    });

    const customerToken = client.createToken(customer.id);

    res.status(200).json({
      customerId: customer.id,
      customerToken,
      channelId: channel.id,
      apiKey,
    });

  } catch (err) {
    console.error(err);
    res.status(500).json({ error: err.message });
  }
});

Registration: Create a contact in the HubSpot API

First, the name inputs are normalized to replace spaces with '_', and the email is converted to lower case. These values will be stored in HubSpot, so having uniform styling makes it easier to call them when needed. Next, a separate method, createHubspotContact() is called to connect to the HubSpot API and create a new contact in the CRM.

//backend/routes/index.js:11
async function createHubspotContact(firstName, lastName, email) {

  let hubspotContact = await Axios.post(`https://api.hubapi.com/crm/v3/objects/contacts?hapikey=${hubspotKey}`,
    {
      properties: {
        'firstname': firstName,
        'lastname': lastName,
        'email': email,
      }
    })
  return hubspotContact.data.id
}

Axios is used to POST the frontend user's inputs to HubSpot's endpoint. The unique hubspotKey is passed to let HubSpot know (1) which account to add the contact to, and (2) that the request is legitimate. The properties passed can match any HubSpot contact property, including custom properties. This method returns HubSpot's unique contact id, which will be helpful later in our webhook.

Take note that the API will check for an existing customer with the email address subitted, and will not overwrite existing users.

Registration: Create a client and users

Once the contact is created, we instantiate a Stream client by passing our unique Stream API Key and Stream Secret.

//backend/routes/index.js:47
const client = new StreamChat.StreamChat(apiKey, apiSecret);

To allow our chat users to join, they will first need to be registered with the client. For this app, only the frontend user and an customer support user are required.

The createUsers method creates an object for each user, with optional properties to control each user's permissions. The method accepts the user inputs to create the customer object, and creates a generic supporter user to represent a technical or sales representative on the other end of the chat.

//backend/routes/index.js:24
function createUsers(firstName, lastName) {
  const customer = {
    id: `${firstName}-${lastName}`.toLowerCase(),
    name: firstName,
    role: 'user',
  };

  const supporter = {
    id: 'adminId',
    name: 'unique-admin-name',
    role: 'admin'
  }
  return [customer, supporter]
}

There are simpler ways to create users in Stream, but this technique illustrates some of Stream's flexibility in doing so. User objects only require an id, but Stream offers a handfull of built-in property options, and accepts any custom property you want to make, as long as the total object size is under 5KB.

Back in the registration handler, the user objects are passed to upsertUsers, which registers the users with the client.

//backend/routes/index.js:51
await client.upsertUsers([
      customer,
      supporter
    ]);

Registration: Create a channel

Next, the /registrations handler starts a Stream channel. Stream's channel() method accepts parameters: ('type', 'id', {channel-data}). Our app uses:

//backend/routes/index.js:55
const channel = client.channel('messaging', hubspotCustomerId, {
      members: [customer.id, supporter.id],
    });

There are a number of different channel types, which are customizable. For this session we'll just use 'messaging'. The id field is important, as our webhook will use it later. The third argument commands that only users with Stream id's matching customer.id or supporter.id will be allowed to enter this channel.

Registration: Respond to the frontend

Last, but not least: we create a customerToken and respond to the frontend of the application with all the data needed to join the chat we have created.

//backend/routes/index.js:60
const customerToken = client.createToken(customer.id);

The frontend then follows a similar process as the backend, but is out of the scope of this post. To learn more check out [this post](LINK TO PREVIOUS POST!!!!!!!!).

Webhook handler

The backend/routes/index.js file also contains the webhook endpoint. Here is the process flow of this endpoint:

Recieve a request from the Stream webhook service.
If the webhook is initiated by a new message event (new.message), continue, otherwise do nothing.
Store the message body and channel id from the webhook request.
Use Axios to retrieve any existing chat transcript form the HubSpot.
Save a local version of the chat transcript, and append the new message
Use Axios to update the custom chat_transcript HubSpot contact property

And here's the code:

//backend/routes/index.js:75
router.post('/webhooks', async (req, res, next) => {
  if (req.body.type === 'message.new') {
    try {
      var newMessage = req.body.message
      var hubspotCustomerId = req.body.channel_id

      await Axios
        .get(`https://api.hubapi.com/crm/v3/objects/contacts/${hubspotCustomerId}`, {
          params: {
            properties: 'chat_transcript',
            archived: false,
            hapikey: hubspotKey,
          }
        })

        .then(async (res) => {
          let localTranscript = res.data.properties.chat_transcript
          let updatedTranscript = `${localTranscript}\n FROM: ${newMessage.user.id}\n SENT AT: ${newMessage.created_at}\n MESSAGE: ${newMessage.text}`

          await Axios
            .patch(`https://api.hubapi.com/crm/v3/objects/contacts/${hubspotCustomerId}?hapikey=${hubspotKey}`, {
              properties: {
                'chat_transcript': updatedTranscript,
              }
            })
            .catch((e) => console.log('Unable to update chat transcript', e))
        }
        )
        .catch((e) => console.log('Customer not found in HubSpot CRM: ', e))
    }

    catch (err) {
      console.log('Webhook did not respond properly', err)
      res.status(200).end()
    }
  }

  res.status(200).end()
})

Let's break down the handler above. Stream's webhook pings this handler anytime an event occurs in our app. We only want to update chat_transcript when a new message is sent, so we add an if then to execute this function only when message.new is the webhook initiator. Stream offers over twenty webhook initiators.

HubSpot's API has plenty of useful endpoints as well. We just need to call two of them. The first call is to retrieve any existing chat transcript saved in HubSpot. We specify the exact contact we want to check by including the hubspotCustomerId, and ask for just their chat transcript using chat_transcript as a parameter. Note that custom contact properties in HubSpot are called using the Label Name shown in the HubSpot property editor window (see below). If you included spaces or dashes in your contact property, use an underscore when referencing it in your request body.

The chat transcript can be customized with whatever properties are useful for your application. The string literal used in this example includes the user.id, created_at date, and message text, each of which are included in the Stream webhook request body. To see the available properties provided by the webhook, use console.log(req.body).

The second Axios request is sent to the HubSpot API's a contact update URL. The request specifies the property to be updated and what to update it with. Multiple properties can be updated at once if desired.

Line 108 is not necessary for the code to run, but ensures that our connection with the HubSpot API will be closed when our task is done. Some API's might flag your app for repeatedly leaving requests open.

Closing thoughts

What may sound like a daunting task can actually be done quite artfully when using the right tools for the job. In this case, the right tools are a chat app with generous webhooks (Stream), and a tactful use of HubSpot API endpoints. Hopefully this post has inspired you creatively and equipped you with skills to make your app tasks easier.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Save a Chat Widget Transcript to a Hubspot CRM Contact Using Webhooks

Overview:

Read this tutorial if you want to...

What's not covered

STEP 1: Account set ups

Set-up your Stream account

Set-up your HubSpot account

Create a custom HubSpot property for a chat transcript

Set your local environment variables

STEP 2: Webhook Setup

What are web hooks?

Setting up a Stream webhook

Quick detour: How Ngrok works

Ngrok setup

Create a backend webhook handler

Configure your public webook URL in Stream

Registration endpoint

Initialization

User registration: starting a chat

Registration: Create a contact in the HubSpot API

Registration: Create a client and users

Registration: Create a channel

Registration: Respond to the frontend

Webhook handler

Closing thoughts

Files

README.md

Latest commit

History

README.md

File metadata and controls

Save a Chat Widget Transcript to a Hubspot CRM Contact Using Webhooks

Overview:

Read this tutorial if you want to...

What's not covered

STEP 1: Account set ups

Set-up your Stream account

Set-up your HubSpot account

Create a custom HubSpot property for a chat transcript

Set your local environment variables

STEP 2: Webhook Setup

What are web hooks?

Setting up a Stream webhook

Quick detour: How Ngrok works

Ngrok setup

Create a backend webhook handler

Configure your public webook URL in Stream

Registration endpoint

Initialization

User registration: starting a chat

Registration: Create a contact in the HubSpot API

Registration: Create a client and users

Registration: Create a channel

Registration: Respond to the frontend

Webhook handler

Closing thoughts