d827e66453
This PR introduces basic minimum version of **Instagram Business Login**, making Instagram inbox setup more straightforward by removing the Facebook Page dependency. This update enhances user experience and aligns with Meta’s recommended best practices. Fixes https://linear.app/chatwoot/issue/CW-3728/instagram-login-how-to-implement-the-changes ## Why Introduce Instagram as a Separate Inbox? Currently, our Instagram integration requires linking an Instagram account to a Facebook Page, making setup complex. To simplify this process, Instagram now offers **Instagram Business Login**, which allows users to authenticate directly with their Instagram credentials. The **Instagram API with Instagram Login** enables businesses and creators to send and receive messages without needing a Facebook Page connection. While an Instagram Business or Creator account is still required, this approach provides a more straightforward integration process. | **Existing Approach (Facebook Login for Business)** | **New Approach (Instagram Business Login)** | | --- | --- | | Requires linking Instagram to a Facebook Page | No Facebook Page required | | Users log in via Facebook credentials | Users log in via Instagram credentials | | Configuration is more complex | Simpler setup | Meta recommends using **Instagram Business Login** as the preferred authentication method due to its easier configuration and improved developer experience. --- ## Implementation Plan The core messaging functionality is already in place, but the transition to **Instagram Business Login** requires adjustments. ### Changes & Considerations - **API Adjustments**: The Instagram API uses `graph.instagram`, whereas Koala (our existing library) interacts with `graph.facebook`. We may need to modify API calls accordingly. - **Three Main Modules**: 1. **Instagram Business Login** – Handle authentication flow. 2. **Permissions & Features** – Ensure necessary API scopes are granted. 3. **Webhooks** – Enable real-time message retrieval.  --- ## Instagram Login Flow 1. User clicks **"Create Inbox"** for Instagram. 2. App redirects to the [Instagram Authorization URL](https://developers.facebook.com/docs/instagram-platform/instagram-api-with-instagram-login/business-login#embed-the-business-login-url). 3. After authentication, Instagram returns an authorization code. 5. The app exchanges the code for a **long-lived token** (valid for 60 days). 6. Tokens are refreshed periodically to maintain access. 7. Once completed, the app creates an inbox and redirects to the Chatwoot dashboard. --- ## How to Test the Instagram Inbox 1. Create a new app on [Meta's Developer Portal](https://developers.facebook.com/apps/). 2. Select **Business** as the app type and configure it. 3. Add the Instagram product and connect a business account. 4. Copy Instagram app ID and Instagram app secret 5. Add the Instagram app ID and Instagram app secret to your app config via `{Chatwoot installation url}/super_admin/app_config?config=instagram` 6. Configure Webhooks: - Callback URL: `{your_chatwoot_url}/webhooks/instagram` - Verify Token: `INSTAGRAM_VERIFY_TOKEN` - Subscribe to `messages`, `messaging_seen`, and `message_reactions` events. 7. Set up **Instagram Business Login**: - Redirect URL: `{your_chatwoot_url}/instagram/callback` 8. Test inbox creation via the Chatwoot dashboard. ## Troubleshooting & Common Errors ### Insufficient Developer Role Error - Ensure the Instagram user is added as a developer: - **Meta Dashboard → App Roles → Roles → Add People → Enter Instagram ID** ### API Access Deactivated - Ensure the **Privacy Policy URL** is valid and correctly set. ### Invalid request: Request parameters are invalid: Invalid redirect_uri - Please configure the Frontend URL. The Frontend URL does not match the authorization URL. --- ## To-Do List - [x] Basic integration setup completed. - [x] Enable sending messages via [Messaging API](https://developers.facebook.com/docs/instagram-platform/instagram-api-with-instagram-login/messaging-api). - [x] Implement automatic webhook subscriptions on inbox creation. - [x] Handle **canceled authorization errors**. - [x] Handle all the errors https://developers.facebook.com/docs/instagram-platform/instagram-graph-api/reference/error-codes - [x] Dynamically fetch **account IDs** instead of hardcoding them. - [x] Prevent duplicate Instagram channel creation for the same account. - [x] Use **Global Config** instead of environment variables. - [x] Explore **Human Agent feature** for message handling. - [x] Write and refine **test cases** for all scenarios. - [x] Implement **token refresh mechanism** (tokens expire after 60 days). Fixes https://github.com/chatwoot/chatwoot/issues/10440 --------- Co-authored-by: Sivin Varghese <64252451+iamsivin@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: Shivam Mishra <scm.mymail@gmail.com>
100 lines
3.0 KiB
YAML
100 lines
3.0 KiB
YAML
# TODO: Move this values to features.yml itself
|
|
# No need to replicate the same values in two places
|
|
captain:
|
|
name: 'Captain'
|
|
description: 'Enable AI-powered conversations with your customers.'
|
|
enabled: <%= (ChatwootHub.pricing_plan != 'community') %>
|
|
icon: 'icon-captain'
|
|
config_key: 'captain'
|
|
enterprise: true
|
|
custom_branding:
|
|
name: 'Custom Branding'
|
|
description: 'Apply your own branding to this installation.'
|
|
enabled: <%= (ChatwootHub.pricing_plan != 'community') %>
|
|
icon: 'icon-paint-brush-line'
|
|
config_key: 'custom_branding'
|
|
enterprise: true
|
|
agent_capacity:
|
|
name: 'Agent Capacity'
|
|
description: 'Set limits to auto-assigning conversations to your agents.'
|
|
enabled: <%= (ChatwootHub.pricing_plan != 'community') %>
|
|
icon: 'icon-hourglass-line'
|
|
enterprise: true
|
|
audit_logs:
|
|
name: 'Audit Logs'
|
|
description: 'Track and trace account activities with ease with detailed audit logs.'
|
|
enabled: <%= (ChatwootHub.pricing_plan != 'community') %>
|
|
icon: 'icon-menu-search-line'
|
|
enterprise: true
|
|
disable_branding:
|
|
name: 'Disable Branding'
|
|
description: 'Disable branding on live-chat widget and external emails.'
|
|
enabled: <%= (ChatwootHub.pricing_plan != 'community') %>
|
|
icon: 'icon-sailbot-fill'
|
|
enterprise: true
|
|
live_chat:
|
|
name: 'Live Chat'
|
|
description: 'Improve your customer experience using a live chat on your website.'
|
|
enabled: true
|
|
icon: 'icon-chat-smile-3-line'
|
|
email:
|
|
name: 'Email'
|
|
description: 'Manage your email customer interactions from Chatwoot.'
|
|
enabled: true
|
|
icon: 'icon-mail-send-fill'
|
|
messenger:
|
|
name: 'Messenger'
|
|
description: 'Stay connected with your customers on Facebook & Instagram.'
|
|
enabled: true
|
|
icon: 'icon-messenger-line'
|
|
config_key: 'facebook'
|
|
whatsapp:
|
|
name: 'WhatsApp'
|
|
description: 'Manage your WhatsApp business interactions from Chatwoot.'
|
|
enabled: true
|
|
icon: 'icon-whatsapp-line'
|
|
telegram:
|
|
name: 'Telegram'
|
|
description: 'Manage your Telegram customer interactions from Chatwoot.'
|
|
enabled: true
|
|
icon: 'icon-telegram-line'
|
|
line:
|
|
name: 'Line'
|
|
description: 'Manage your Line customer interactions from Chatwoot.'
|
|
enabled: true
|
|
icon: 'icon-line-line'
|
|
sms:
|
|
name: 'SMS'
|
|
description: 'Manage your SMS customer interactions from Chatwoot.'
|
|
enabled: true
|
|
icon: 'icon-message-line'
|
|
help_center:
|
|
name: 'Help Center'
|
|
description: 'Allow agents to create help center articles and publish them in a portal.'
|
|
enabled: true
|
|
icon: 'icon-book-2-line'
|
|
microsoft:
|
|
name: 'Microsoft'
|
|
description: 'Configuration for setting up Microsoft Email'
|
|
enabled: true
|
|
icon: 'icon-microsoft'
|
|
config_key: 'microsoft'
|
|
linear:
|
|
name: 'Linear'
|
|
description: 'Configuration for setting up Linear'
|
|
enabled: true
|
|
icon: 'icon-linear'
|
|
config_key: 'linear'
|
|
instagram:
|
|
name: 'Instagram'
|
|
description: 'Configuration for setting up Instagram'
|
|
enabled: true
|
|
icon: 'icon-instagram'
|
|
config_key: 'instagram'
|
|
shopify:
|
|
name: 'Shopify'
|
|
description: 'Configuration for setting up Shopify'
|
|
enabled: true
|
|
icon: 'icon-shopify'
|
|
config_key: 'shopify'
|