wechaty-plugin-intercom

wechaty-plugin-intercom

Intercom is a Conversational Relationship Platform (CRP).

Wechaty Intercom Plugin helps you build better customer relationships through WeChat across the customer journey.

Introduction

Wechaty Intercom Plugin helps you to manage your customers/leads/users in the WeChat Room, with the power of the Intercom service.

Usage

import { WechatyIntercom } from 'wechaty-plugin-intercom'

const config = {
  room: 'room_id@chatroom',

  mention: true,
  webhookProxyUrl : 'https://smee.io/your_smee_io_proxy_url',
  intercomToken   : 'your_intercom_authorization_token',
}

const IntercomPlugin = WechatyIntercom(config)

const wechaty = new Wechaty()
wechaty.use(IntercomPlugin)

• config.room: The room id of your service WeChat room.
• config.mention: If set to true, customers need to use @ to mention the bot when they want to ask questions.
• config.webhookProxyUrl: A semee.io link that you need to set it to receive the Intercom Webhook events.
  • Intercom Developer Hub - Webhook Topics
  • smee.io - Webhook payload delivery service - Receives payloads then sends them to your locally running application.
• config.intercomToken: The Authorization Token for your Intercom account.
  • Intercom Developer Hub - How to get your Access Token

Configure Intercom Webhooks

In order to receive the reply and close events from Intercom, we need to configure two webhooks:

• conversation.admin.replied
• conversation.admin.closed

The request endpoint URL must be as same as the webhookProxyUrl setting in the config.

Do not forget to click [Save] button after you set them.

Environment Variables

The following two environment variables will be used if the required information is not provided by the config.

1 WECHATY_PLUGIN_INTERCOM_TOKEN

process.env.WECHATY_PLUGIN_INTERCOM_TOKEN will be used if the config.intercomToken is not provided.

Learn more about the authorization token of intercom: Intercom Developers - How to get your Access Token

2 WECHATY_PLUGIN_INTERCOM_WEBHOOK_PROXY_URL

We receive webhook payloads with the help from <smee.io>, by proxy them to our locally running Wechaty Plugin application.

process.env.WECHATY_PLUGIN_INTERCOM_WEBHOOK_PROXY_URL will be used if the config.webhookProxyUrl is not provided.

See:

• Intercom Developer Hub - Webhook Topics
• smee.io - Webhook payload delivery service - Receives payloads then sends them to your locally running application.

Screenshot

Example

Our Friday BOT are using wechaty-plugin-intercom to connect our WeChat customers to Intercom.

You can read the source code from: https://github.com/wechaty/friday/blob/master/src/plugins/intercom.ts

History

v0.4 master

• Rename at to mention in config.

v0.2 (Jun 2020)

• Init code base
• Room message to Intercom
• Intercom message to Room (Powered by Smee.io)

Contributors

Author

Huan LI (李卓桓), Tencent TVP of Chatbot, <[e-mail]>

Copyright & License

• Code & Docs © 2020 Huan LI <[e-mail]>
• Code released under the Apache-2.0 License
• Docs released under Creative Commons