Mirror importado do GitHub: https://github.com/Rodribm10/iachat
Go to file
Mazen Khalil ca5e112a8c
feat: TikTok channel (#12741)
fixes: #11834

This pull request introduces TikTok channel integration, enabling users
to connect and manage TikTok business accounts similarly to other
supported social channels. The changes span backend API endpoints,
authentication helpers, webhook handling, configuration, and frontend
components to support TikTok as a first-class channel.


**Key Notes**
* This integration is only compatible with TikTok Business Accounts
* Special permissions are required to access the TikTok [Business
Messaging
API](https://business-api.tiktok.com/portal/docs?id=1832183871604753).
* The Business Messaging API is region-restricted and is currently
unavailable to users in the EU.
* Only TEXT, IMAGE, and POST_SHARE messages are currently supported due
to limitations in the TikTok Business Messaging API
* A message will be successfully sent only if it contains text alone or
one image attachment. Messages with multiple attachments or those
combining text and attachments will fail and receive a descriptive error
status.
* Messages sent directly from the TikTok App will be synced into the
system
* Initiating a new conversation from the system is not permitted due to
limitations from the TikTok Business Messaging API.


**Backend: TikTok Channel Integration**

* Added `Api::V1::Accounts::Tiktok::AuthorizationsController` to handle
TikTok OAuth authorization initiation, returning the TikTok
authorization URL.
* Implemented `Tiktok::CallbacksController` to handle TikTok OAuth
callback, process authorization results, create or update channel/inbox,
and handle errors or denied scopes.
* Added `Webhooks::TiktokController` to receive and verify TikTok
webhook events, including signature verification and event dispatching.
* Created `Tiktok::IntegrationHelper` module for JWT-based token
generation and verification for secure TikTok OAuth state management.

**Configuration and Feature Flags**

* Added TikTok app credentials (`TIKTOK_APP_ID`, `TIKTOK_APP_SECRET`) to
allowed configs and app config, and registered TikTok as a feature in
the super admin features YAML.
[[1]](diffhunk://#diff-5e46e1d248631a1147521477d84a54f8ba6846ea21c61eca5f70042d960467f4R43)
[[2]](diffhunk://#diff-8bf37a019cab1dedea458c437bd93e34af1d6e22b1672b1d43ef6eaa4dcb7732R69)
[[3]](diffhunk://#diff-123164bea29f3c096b0d018702b090d5ae670760c729141bd4169a36f5f5c1caR74-R79)

**Frontend: TikTok Channel UI and Messaging Support**

* Added `TiktokChannel` API client for frontend TikTok authorization
requests.
* Updated channel icon mappings and tests to include TikTok
(`Channel::Tiktok`).
[[1]](diffhunk://#diff-b852739ed45def61218d581d0de1ba73f213f55570aa5eec52aaa08f380d0e16R16)
[[2]](diffhunk://#diff-3cd3ae32e94ef85f1f2c4435abf0775cc0614fb37ee25d97945cd51573ef199eR64-R69)
* Enabled TikTok as a supported channel in contact forms, channel
widgets, and feature toggles.
[[1]](diffhunk://#diff-ec59c85e1403aaed1a7de35971fe16b7033d5cd763be590903ebf8f1ca25a010R47)
[[2]](diffhunk://#diff-ec59c85e1403aaed1a7de35971fe16b7033d5cd763be590903ebf8f1ca25a010R69)
[[3]](diffhunk://#diff-725b90ca7e3a6837ec8291e9f57094f6a46b3ee00e598d16564f77f32cf354b0R26-R29)
[[4]](diffhunk://#diff-725b90ca7e3a6837ec8291e9f57094f6a46b3ee00e598d16564f77f32cf354b0R51-R54)
[[5]](diffhunk://#diff-725b90ca7e3a6837ec8291e9f57094f6a46b3ee00e598d16564f77f32cf354b0R68)
* Updated message meta logic to support TikTok-specific message statuses
(sent, delivered, read).
[[1]](diffhunk://#diff-e41239cf8dda36c1bd1066dbb17588ae8868e56289072c74b3a6d7ef5abdd696R23)
[[2]](diffhunk://#diff-e41239cf8dda36c1bd1066dbb17588ae8868e56289072c74b3a6d7ef5abdd696L63-R65)
[[3]](diffhunk://#diff-e41239cf8dda36c1bd1066dbb17588ae8868e56289072c74b3a6d7ef5abdd696L81-R84)
[[4]](diffhunk://#diff-e41239cf8dda36c1bd1066dbb17588ae8868e56289072c74b3a6d7ef5abdd696L103-R107)
* Added support for embedded message attachments (e.g., TikTok embeds)
with a new `EmbedBubble` component and updated message rendering logic.
[[1]](diffhunk://#diff-c3d701caf27d9c31e200c6143c11a11b9d8826f78aa2ce5aa107470e6fdb9d7fR31)
[[2]](diffhunk://#diff-047859f9368a46d6d20177df7d6d623768488ecc38a5b1e284f958fad49add68R1-R19)
[[3]](diffhunk://#diff-c3d701caf27d9c31e200c6143c11a11b9d8826f78aa2ce5aa107470e6fdb9d7fR316)
[[4]](diffhunk://#diff-cbc85e7c4c8d56f2a847d0b01cd48ef36e5f87b43023bff0520fdfc707283085R52)
* Adjusted reply policy and UI messaging for TikTok's 48-hour reply
window.
[[1]](diffhunk://#diff-0d691f6a983bd89502f91253ecf22e871314545d1e3d3b106fbfc76bf6d8e1c7R208-R210)
[[2]](diffhunk://#diff-0d691f6a983bd89502f91253ecf22e871314545d1e3d3b106fbfc76bf6d8e1c7R224-R226)

These changes collectively enable end-to-end TikTok channel support,
from configuration and OAuth flow to webhook processing and frontend
message handling.


------------

# TikTok App Setup & Configuration
1. Grant access to the Business Messaging API
([Documentation](https://business-api.tiktok.com/portal/docs?id=1832184145137922))
2. Set the app authorization redirect URL to
`https://FRONTEND_URL/tiktok/callback`
3. Update the installation config with TikTok App ID and Secret
4. Create a Business Messaging Webhook configuration and set the
callback url to `https://FRONTEND_URL/webhooks/tiktok`
([Documentation](https://business-api.tiktok.com/portal/docs?id=1832190670631937))
. You can do this by calling
`Tiktok::AuthClient.update_webhook_callback` from rails console once you
finish Tiktok channel configuration in super admin ( will be automated
in future )
5. Enable TikTok channel feature in an account

---------

Co-authored-by: Sojan Jose <sojan@pepalo.com>
Co-authored-by: iamsivin <iamsivin@gmail.com>
2025-12-17 07:54:50 -08:00
__mocks__ Feature: Agent Profile Update with avatar (#449) 2020-02-16 17:20:38 +05:30
.circleci feat: speed up circleci and github actions (#12849) 2025-11-19 15:32:48 +05:30
.dependabot Add Dependabot config (#217) 2019-11-25 09:48:11 +05:30
.devcontainer chore: Improvements to codespaces (#11635) 2025-05-29 21:18:02 -06:00
.github feat: speed up circleci and github actions (#12849) 2025-11-19 15:32:48 +05:30
.husky fix: Update pre-commit hook to handle staged deleted files (#11357) 2025-04-24 16:54:53 +05:30
.qlty feat: Add Pinia support and relocate store factory (#12854) 2025-11-28 16:31:59 +05:30
.vscode feat: Add the option for consent form (#6511) 2023-02-28 13:57:05 +05:30
.windsurf/rules chore: Add development guidelines documentation for AI Agents (#11243) 2025-05-16 19:23:10 -07:00
app feat: TikTok channel (#12741) 2025-12-17 07:54:50 -08:00
bin chore: Update translations, add pnpm sync:i18n command (#10893) 2025-02-12 17:43:46 -08:00
clevercloud feat: Add support for Clever cloud deployments (#1703) 2021-01-29 17:08:40 +05:30
config feat: TikTok channel (#12741) 2025-12-17 07:54:50 -08:00
db feat: TikTok channel (#12741) 2025-12-17 07:54:50 -08:00
deployment fix: reduce sidekiq memorymax to 1.2gb (#12915) 2025-11-20 21:20:42 +05:30
docker chore: upgrade ruby version to 3.4.4 (#11524) 2025-05-21 19:40:07 +05:30
enterprise feat(enterprise): add voice conference API (#13064) 2025-12-15 15:11:59 -08:00
lib feat: TikTok channel (#12741) 2025-12-17 07:54:50 -08:00
log Initial Commit 2019-08-14 15:18:44 +05:30
public feat: TikTok channel (#12741) 2025-12-17 07:54:50 -08:00
rubocop fix: stream attachment handling in workers (#12870) 2025-12-05 13:02:53 -08:00
script chore: add script to throttle bulkreindex job creation and increase meta timeouts(#12626) 2025-10-13 16:21:45 +05:30
spec feat: TikTok channel (#12741) 2025-12-17 07:54:50 -08:00
swagger feat(webhooks): add name to webhook (#12641) 2025-11-13 13:28:15 +05:30
theme feat: TikTok channel (#12741) 2025-12-17 07:54:50 -08:00
tmp Initial Commit 2019-08-14 15:18:44 +05:30
vendor feat: Sentiment model download and upload to vendor (#7526) 2023-07-18 12:17:50 +05:30
.all-contributorsrc [docs] Move contributors section to docs (#120) 2019-10-06 09:23:24 +05:30
.browserslistrc Initial Commit 2019-08-14 15:18:44 +05:30
.bundler-audit.yml chore: mitigate CVE-2021-41098 (#3101) 2021-09-28 19:34:11 +05:30
.dockerignore chore: add build id to settings page (#6873) 2023-04-18 00:35:35 +05:30
.editorconfig fix: Update .editorconfig to fix spaces and indent_style (#5612) 2022-10-12 14:00:42 -07:00
.env.example feat: Add support for Langfuse LLM Tracing via OTEL (#12905) 2025-11-21 16:31:45 -08:00
.eslintrc.js chore: Add "Coming Soon" overlay to voice channel selector (#11835) 2025-06-30 14:30:09 +05:30
.gitignore feat: Add support for Langfuse LLM Tracing via OTEL (#12905) 2025-11-21 16:31:45 -08:00
.nvmrc chore: update vulnerable packages (#12996) 2025-12-04 15:28:12 +05:30
.prettierrc chore: Execute campaigns based on matching URL (#2254) 2021-05-17 21:38:35 +05:30
.rspec Fix url in emails, add frontendURL helper (#19) 2019-08-25 19:59:28 +05:30
.rubocop.yml fix: stream attachment handling in workers (#12870) 2025-12-05 13:02:53 -08:00
.ruby-version chore: upgrade ruby version to 3.4.4 (#11524) 2025-05-21 19:40:07 +05:30
.scss-lint.yml feat(apps): Shopify Integration (#11101) 2025-03-19 15:37:55 -07:00
.slugignore chore: Upgrade to Rails 7 (#6719) 2023-05-06 10:44:52 +05:30
AGENTS.md feat(enterprise): add voice conference API (#13064) 2025-12-15 15:11:59 -08:00
app.json fix: update omniauth to latest to resolve heroku deployment issues (#12749) 2025-10-29 08:54:29 -07:00
Capfile 🚨Fix Rubocop lint errors 2019-10-20 14:17:26 +05:30
CLAUDE.md chore: Add development guidelines documentation for AI Agents (#11243) 2025-05-16 19:23:10 -07:00
CODE_OF_CONDUCT.md General updates and add CODEOWNERS (#3685) 2022-01-05 12:37:22 +05:30
config.ru Initial Commit 2019-08-14 15:18:44 +05:30
CONTRIBUTING.md General updates and add CODEOWNERS (#3685) 2022-01-05 12:37:22 +05:30
crowdin.yml chore: Update Crowdin Config (#7375) 2023-06-23 23:02:55 +05:30
docker-compose.production.yaml fix: add named volumes for storage, postgres, and redis (#11465) 2025-05-12 17:32:12 +05:30
docker-compose.test.yaml feat: switch to postgres docker images with pgvector support (v4.0) (#10658) 2025-01-14 19:45:42 +05:30
docker-compose.yaml feat: switch to postgres docker images with pgvector support (v4.0) (#10658) 2025-01-14 19:45:42 +05:30
Gemfile feat: Standardize rich editor across all channels (#12600) 2025-12-08 14:43:45 +05:30
Gemfile.lock feat: legacy features to ruby llm (#12994) 2025-12-11 14:17:28 +05:30
histoire.config.ts chore(dev): Update histoire config for deployment (#12374) 2025-09-11 13:05:54 +05:30
LICENSE chore: Update year in LICENSE (#8835) 2024-02-01 15:37:05 +05:30
Makefile chore: Improvements for codespace (#11667) 2025-06-04 00:21:23 -05:00
package.json feat(ce): Add Year in review feature (#13078) 2025-12-15 17:24:45 -08:00
pnpm-lock.yaml feat(ce): Add Year in review feature (#13078) 2025-12-15 17:24:45 -08:00
postcss.config.js feat: Vite + vue 3 💚 (#10047) 2024-10-02 00:36:30 -07:00
Procfile chore: add build id to settings page (#6873) 2023-04-18 00:35:35 +05:30
Procfile.dev feat: Vite + vue 3 💚 (#10047) 2024-10-02 00:36:30 -07:00
Procfile.test feat: Vite + vue 3 💚 (#10047) 2024-10-02 00:36:30 -07:00
Procfile.tunnel chore: Improvements for codespace (#11667) 2025-06-04 00:21:23 -05:00
Rakefile fix: Search rake task causing Rails boot error (#12416) 2025-09-15 22:21:59 +05:30
README.md chore: Update readme (#11154) 2025-03-21 18:14:51 -07:00
SECURITY.md chore: Update SECURITY.md (#10705) 2025-01-16 10:59:33 -08:00
semantic.yml Chore: Update copy on Signup page (#1023) 2020-07-09 16:28:09 +05:30
tailwind.config.js feat(ce): Add Year in review feature (#13078) 2025-12-15 17:24:45 -08:00
VERSION_CW chore: increment CW version (#12902) 2025-11-19 17:10:01 +05:30
VERSION_CWCTL fix: cwctl version to handle the upgrade loop (#12232) 2025-08-21 14:56:29 +05:30
vite.config.ts feat: speed up circleci and github actions (#12849) 2025-11-19 15:32:48 +05:30
vitest.setup.js chore: Update buttons in dashboard (#11145) 2025-03-31 17:21:32 -07:00
workbox-config.js [Feature] Add PWA support (#157) 2019-10-18 12:37:09 +05:30

Header light mode Header dark mode

Chatwoot

The modern customer support platform, an open-source alternative to Intercom, Zendesk, Salesforce Service Cloud etc.

Maintainability CircleCI Badge Docker Pull Badge Docker Build Badge Commits-per-month Discord uptime response time Artifact HUB

Deploy Deploy to DO

Chat dashboard dark mode Chat dashboard

Chatwoot is the modern, open-source, and self-hosted customer support platform designed to help businesses deliver exceptional customer support experience. Built for scale and flexibility, Chatwoot gives you full control over your customer data while providing powerful tools to manage conversations across channels.

Captain AI Agent for Support

Supercharge your support with Captain, Chatwoots AI agent. Captain helps automate responses, handle common queries, and reduce agent workload—ensuring customers get instant, accurate answers. With Captain, your team can focus on complex conversations while routine questions are resolved automatically. Read more about Captain here.

💬 Omnichannel Support Desk

Chatwoot centralizes all customer conversations into one powerful inbox, no matter where your customers reach out from. It supports live chat on your website, email, Facebook, Instagram, Twitter, WhatsApp, Telegram, Line, SMS etc.

📚 Help center portal

Publish help articles, FAQs, and guides through the built-in Help Center Portal. Enable customers to find answers on their own, reduce repetitive queries, and keep your support team focused on more complex issues.

🗂️ Other features

Collaboration & Productivity

  • Private Notes and @mentions for internal team discussions.
  • Labels to organize and categorize conversations.
  • Keyboard Shortcuts and a Command Bar for quick navigation.
  • Canned Responses to reply faster to frequently asked questions.
  • Auto-Assignment to route conversations based on agent availability.
  • Multi-lingual Support to serve customers in multiple languages.
  • Custom Views and Filters for better inbox organization.
  • Business Hours and Auto-Responders to manage response expectations.
  • Teams and Automation tools for scaling support workflows.
  • Agent Capacity Management to balance workload across the team.

Customer Data & Segmentation

  • Contact Management with profiles and interaction history.
  • Contact Segments and Notes for targeted communication.
  • Campaigns to proactively engage customers.
  • Custom Attributes for storing additional customer data.
  • Pre-Chat Forms to collect user information before starting conversations.

Integrations

  • Slack Integration to manage conversations directly from Slack.
  • Dialogflow Integration for chatbot automation.
  • Dashboard Apps to embed internal tools within Chatwoot.
  • Shopify Integration to view and manage customer orders right within Chatwoot.
  • Use Google Translate to translate messages from your customers in realtime.
  • Create and manage Linear tickets within Chatwoot.

Reports & Insights

  • Live View of ongoing conversations for real-time monitoring.
  • Conversation, Agent, Inbox, Label, and Team Reports for operational visibility.
  • CSAT Reports to measure customer satisfaction.
  • Downloadable Reports for offline analysis and reporting.

Documentation

Detailed documentation is available at chatwoot.com/help-center.

Translation process

The translation process for Chatwoot web and mobile app is managed at https://translate.chatwoot.com using Crowdin. Please read the translation guide for contributing to Chatwoot.

Branching model

We use the git-flow branching model. The base branch is develop. If you are looking for a stable version, please use the master or tags labelled as v1.x.x.

Deployment

Heroku one-click deploy

Deploying Chatwoot to Heroku is a breeze. It's as simple as clicking this button:

Deploy

Follow this link to understand setting the correct environment variables for the app to work with all the features. There might be breakages if you do not set the relevant environment variables.

DigitalOcean 1-Click Kubernetes deployment

Chatwoot now supports 1-Click deployment to DigitalOcean as a kubernetes app.

Deploy to DO

Other deployment options

For other supported options, checkout our deployment page.

Security

Looking to report a vulnerability? Please refer our SECURITY.md file.

Community

If you need help or just want to hang out, come, say hi on our Discord server.

Contributors

Thanks goes to all these wonderful people:

Chatwoot © 2017-2025, Chatwoot Inc - Released under the MIT License.