Chatwoot Integration Guide

[smashah]

Setup

TODO

• Fix the URL in the chatwoot inbox setup video. It should be .../chatwoot
• Show how to add the api key to chatwoot inbox setup. .../chatwoot?api_key=xxxxxxxx

Step 1

Create a new inbox with the API channel.

If you already know your EASY API host, then set the webhook now (e.g if your easy api is on http://localhost:8006 then set the webhook http://localhost:8006/chatwoot. You can do this later also.

Step 2

Go to your newly created inbox in the conversations tab. Note down the url, use that to convert it to the chatwoot api url.

http://localhost:3000/app/accounts/1/inbox/1 becomes http://localhost:3000/api/v1/accounts/1/inboxes/1 - basically replace app with api/v1

ezgif.com-gif-maker.mp4

Step 3

Grab the access token from the bottom of the Profile settings page. E.g qZgaibhBPQQqddtGUeytsFqu

Step 4

Start the easy API with --chatwoot-url="http://localhost:3000/api/v1/accounts/1/inboxes/1" and --chatwoot-api-access-token=qZgaibhBPQQqddtGUeytsFqu

Step 5

If you haven't already, set the webhook url for your EASY API instance on the new inbox Settings > Inboxes > [Your inbox] > Settings > WEBHOOK URL

extra media:

Tip

If you are running your chatwoot docker container in the same host as your sessions then you need to make sure the chatwoot instance can "reach" your sessions by exposing localhost to your docker container and then informing your easy api of the api host to expect requests on.

add this line to the rails and worker services in the chatwoot docker-compose yaml:

    extra_hosts:
      - "host.docker.internal:host-gateway"

Now lets say for example your session is running on port 8006 in the host machine, your inbox webhook url will be http://host.docker.internal:8006/chatwoot

If you have further issues then you need to inform easy api of the api host that it is now being addressed by, you can do this by adding the cli flag --api-host http://host.docker.internal or apiHost: "http://host.docker.internal"

[trcalgaro]

I managed to make the connection and I see the messages generated in wa-automate, but when I answer in chatwood the message does not return to wa-automate, is there this possibility?

[trcalgaro]

@smashah
Thanks for the tip

I used your recommendations in the cli.config file but still the messages still don't return from chatwoot to wa

I tried restarting the chatwoot service anyway, without success!

[smashah]

@trcalgaro I just noticed, in your screenshot you set the url in chatwoot as http://170.10.10.127:8101

That is the address of the instance, you need to add the specific endpoint /chatwoot.

Change it to:

http://170.10.10.127:8101/chatwoot

[trcalgaro]

Now yes... returned

Thanks for the help, it would be important to put the proper path in the inbox webhook in the tutorial.

I tested here adding the "key" again and it doesn't really work with it. I think you can handle the error yes, since it would be important to keep the key for other communications via socket (Node Red for example), or swagger API

[smashah]

@trcalgaro

Seems as though I have forgotten that I already did this:

wa-automate-nodejs/src/cli/server.ts

Line 53 in 33568e0

if (req.path.includes('chatwoot') && req.query['api_key'] && req.query['api_key'] == cliConfig.key) {

So this should work in chatwoot inbox settings:

http://170.10.10.127:8101/chatwoot?api_key=xxxxxxxxxxxxxxxx

[trcalgaro]

Tks, its Working!

[hasanphd]

Hi @smashah I tried all that's said above and tried to configure Chatwoot with WhatsApp.
However, failed to make the outgoing messages work. Incoming of messages is working fine.

I couldn't figure out the config.js correctly so deleted that.

Command I am using:

npx @open-wa/wa-automate -p 8082 --chatwoot-url "http://127.0.0.1:3000/app/accounts/1/inbox/2" --chatwoot-api-access-token xxxxxxxxxxxxxxxxxx

[hasanphd]

Actually, both chatwoot and open-wa are on Localhost. Chatwoot running in WSL. And open-wa via Windows.
Both localhost URLs work fine, but outgoing messages does not work that are sent from Chatwoot API call to open-wa.

I checked and it does not seem to be port issue. I will however deploy chatwoot to ngrok too and see meanwhile you get a chance to respond here.

[smashah]

Just because you can access both on localhost doesn't mean chatwoot has access to the open-wa port. If chatwoot is running within docker and based on your setup, you can access chatwoot on localhost but your chatwoot instance cannot connect to the machine's localhost network to access port 8082 to send requests to open-wa. My advice was to put an ngrok infront of open-wa then update your inbox settings with the ngrok url - not the other way around.

If you want to test your open-wa API you can use the /api-docs/

[hasanphd]

It worked! Genius!

[fejorca]

I'm having this same issue, wa-automate is running on a docker container and messages are going to the chatwoot inbox but can't respond to any message, wa-automate docker container has a public address but when trying to use the url with "/chatwoot" it shows a message that says "Cannot GET /chatwoot", also I can see api-docs and test without issues but can't get chatwoot message responses

EDIT: I'm using NPM with let's encrypt certificates

[smashah]

@fejorca /chatwoot is solely a POST path designed for chatwoot - not for a front end user.

The problem is that chatwoot docker compose setup is running on it's own network - it doesn't have access to the host network.

Please follow this issue for updates:

#2869

[smashah]

@fejorca @hasanphd @trcalgaro @apnerve

Please track this issue for massive chatwoot integration QoL improvements:

#2869

[lazmo88]

@smashah just got this up and running and so far so good. Only issue I noticed is that Chatwoot won't receive replies sent from other devices or WA web UI. Is this normal or expected behaviour? It would be great if all conversation history could stay in sync also on CW, including replies agents sent from WA web or WA mobile apps.