{"id":28445051,"url":"https://github.com/wechaty/plugin-intercom","last_synced_at":"2025-06-29T20:33:04.407Z","repository":{"id":47257813,"uuid":"274138110","full_name":"wechaty/plugin-intercom","owner":"wechaty","description":"Wechaty Intercom Plugin helps you build better customer relationships through WeChat across the customer journey.","archived":false,"fork":false,"pushed_at":"2021-10-23T07:45:57.000Z","size":758,"stargazers_count":1,"open_issues_count":2,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-31T20:52:10.933Z","etag":null,"topics":["helpdesk","intercom","plugin","wechat","wechaty-plugin"],"latest_commit_sha":null,"homepage":"https://paka.dev/npm/wechaty-plugin-intercom","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wechaty.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-22T13:01:31.000Z","updated_at":"2021-11-30T01:34:38.000Z","dependencies_parsed_at":"2022-07-20T20:19:01.854Z","dependency_job_id":null,"html_url":"https://github.com/wechaty/plugin-intercom","commit_stats":null,"previous_names":["wechaty/wechaty-intercom","wechaty/wechaty-plugin-intercom"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/wechaty/plugin-intercom","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fplugin-intercom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fplugin-intercom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fplugin-intercom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fplugin-intercom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wechaty","download_url":"https://codeload.github.com/wechaty/plugin-intercom/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fplugin-intercom/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259945374,"owners_count":22935792,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["helpdesk","intercom","plugin","wechat","wechaty-plugin"],"created_at":"2025-06-06T10:11:11.306Z","updated_at":"2025-06-29T20:33:04.393Z","avatar_url":"https://github.com/wechaty.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# wechaty-intercom [![Wechaty Plugin Intercom](https://img.shields.io/badge/Wechaty%20Plugin-Intercom-brightgreen.svg)](https://github.com/wechaty/wechaty-intercom)\n\n [![NPM Version](https://img.shields.io/npm/v/wechaty-intercom?color=brightgreen)](https://www.npmjs.com/package/wechaty-intercom)\n [![NPM](https://github.com/wechaty/wechaty-intercom/workflows/NPM/badge.svg)](https://github.com/wechaty/wechaty-intercom/actions?query=workflow%3ANPM)\n\nIntercom is a Conversational Relationship Platform (CRP).\n\nWechaty Intercom Plugin helps you build better customer relationships through WeChat across the customer journey.\n\n![Wechaty Plugin Intercom](docs/images/intercom-wechaty.png)\n\n[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-brightgreen.svg)](https://github.com/Wechaty/wechaty)\n[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-blue.svg)](https://www.typescriptlang.org/)\n\n## Introduction\n\nWechaty Intercom Plugin helps you to manage your customers/leads/users in the WeChat Room, with the power of the Intercom service.\n\n## Usage\n\n```ts\nimport { WechatyIntercom } from 'wechaty-intercom'\n\nconst config = {\n  room: 'room_id@chatroom',\n\n  mention: true,\n  webhookProxyUrl : 'https://smee.io/your_smee_io_proxy_url',\n  intercomToken   : 'your_intercom_authorization_token',\n}\n\nconst IntercomPlugin = WechatyIntercom(config)\n\nconst wechaty = new Wechaty()\nwechaty.use(IntercomPlugin)\n```\n\n1. `config.room`: The room id of your service WeChat room.\n1. `config.mention`: If set to `true`, customers need to use `@` to mention the bot when they want to ask questions.\n1. `config.webhookProxyUrl`: A `semee.io` link that you need to set it to receive the Intercom Webhook events.\n    1. [Intercom Developer Hub - Webhook Topics](https://developers.intercom.com/building-apps/docs/webhook-model#section-webhook-topics)\n    1. [smee.io - Webhook payload delivery service](https://smee.io/) - Receives payloads then sends them to your locally running application.\n1. `config.intercomToken`: The Authorization Token for your Intercom account.\n    1. [Intercom Developer Hub - How to get your Access Token](https://developers.intercom.com/building-apps/docs/authentication-types#section-how-to-get-your-access-token)\n\n## Configure Intercom Webhooks\n\nIn order to receive the reply and close events from Intercom, we need to configure two webhooks:\n\n1. `conversation.admin.replied`\n1. `conversation.admin.closed`\n\nThe `request endpoint URL` must be as same as the `webhookProxyUrl` setting in the `config`.\n\n![Intercom Webhooks](docs/images/intercom-webhooks.png)\n\n\u003e Do not forget to click [Save] button after you set them.\n\n## Environment Variables\n\nThe following two environment variables will be used if the required information is not provided by the config.\n\n### 1 `WECHATY_PLUGIN_INTERCOM_TOKEN`\n\n`process.env.WECHATY_PLUGIN_INTERCOM_TOKEN` will be used if the `config.intercomToken` is not provided.\n\nLearn more about the authorization token of intercom: [Intercom Developers - How to get your Access Token](https://developers.intercom.com/building-apps/docs/authentication-types#section-how-to-get-your-access-token)\n\n### 2 `WECHATY_PLUGIN_INTERCOM_WEBHOOK_PROXY_URL`\n\nWe receive webhook payloads with the help from \u003csmee.io\u003e, by proxy them to our locally running Wechaty Plugin application.\n\n`process.env.WECHATY_PLUGIN_INTERCOM_WEBHOOK_PROXY_URL` will be used if the `config.webhookProxyUrl` is not provided.\n\nSee:\n\n1. [Intercom Developer Hub - Webhook Topics](https://developers.intercom.com/building-apps/docs/webhook-model#section-webhook-topics)\n1. [smee.io - Webhook payload delivery service](https://smee.io/) - Receives payloads then sends them to your locally running application.\n\n## Screenshot\n\n![Wechaty Intercom Conversation](docs/images/wechaty-intercom-conversation.png)\n\n## Example\n\nOur Friday BOT are using `wechaty-intercom` to connect our WeChat customers to Intercom.\n\nYou can read the source code from: \u003chttps://github.com/wechaty/friday/blob/master/src/plugins/intercom.ts\u003e\n\n## History\n\n### v1.0 (Oct 23, 2021)\n\nRelease v1.0 of Wechaty Intercom Plugin.\n\n### v0.4 master\n\n1. Renamed from `wechaty-plugin-intercom` to `wechaty-intercom`.\n1. Rename `at` to `mention` in config.\n\n### v0.2 (Jun 2020)\n\n1. Init code base\n1. Room message to Intercom\n1. Intercom message to Room (Powered by Smee.io)\n\n## Contributors\n\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/images/0)](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/links/0)\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/images/1)](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/links/1)\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/images/2)](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/links/2)\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/images/3)](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/links/3)\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/images/4)](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/links/4)\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/images/5)](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/links/5)\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/images/6)](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/links/6)\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/images/7)](https://sourcerer.io/fame/huan/wechaty/wechaty-intercom/links/7)\n\n## Author\n\n[Huan LI](https://github.com/huan) ([李卓桓](http://linkedin.com/in/zixia)),\nTencent TVP of Chatbot, \\\u003czixia@zixia.net\\\u003e\n\n[![Profile of Huan LI (李卓桓) on StackOverflow](https://stackexchange.com/users/flair/265499.png)](https://stackexchange.com/users/265499)\n\n## Copyright \u0026 License\n\n* Code \u0026 Docs © 2020 Huan LI \\\u003czixia@zixia.net\\\u003e\n* Code released under the Apache-2.0 License\n* Docs released under Creative Commons\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fplugin-intercom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwechaty%2Fplugin-intercom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fplugin-intercom/lists"}