iachat/app/javascript/dashboard/components/widgets
Muhsin Keloth d827e66453
feat: Instagram Inbox using Instagram Business Login (#11054)
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.

![CleanShot 2025-03-10 at 21 32
28@2x](https://github.com/user-attachments/assets/1b019001-8d16-4e59-aca2-ced81e98f538)


---

## 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>
2025-04-08 10:47:41 +05:30
..
conversation feat: Instagram Inbox using Instagram Business Login (#11054) 2025-04-08 10:47:41 +05:30
DashboardApp fix: Use addEventListener instead of onmessage to listen to chatwoot-dashboard-app:fetch-info (#10342) 2024-10-28 20:43:47 -07:00
FilterInput chore: Update buttons in conversation screens(#11132) 2025-03-21 14:47:28 +05:30
forms chore: Update buttons in dashboard (#11145) 2025-03-31 17:21:32 -07:00
mentions feat: update colors for v4 (#10660) 2025-01-15 17:13:03 +05:30
modal chore: Update buttons in conversation screens - 2 (#11134) 2025-03-21 21:54:54 +05:30
WootWriter chore: Reply window fixes (#11242) 2025-04-04 13:03:41 +05:30
AIAssistanceButton.vue chore: Update reply editor design (#10575) 2025-01-08 17:49:53 +05:30
AIAssistanceCTAButton.vue chore: Update reply editor design (#10575) 2025-01-08 17:49:53 +05:30
AIAssistanceModal.vue chore: Update buttons in conversation screens(#11132) 2025-03-21 14:47:28 +05:30
AICTAModal.vue chore: Update buttons in conversation screens(#11132) 2025-03-21 14:47:28 +05:30
AILoader.vue feat: Eslint rules (#9839) 2024-08-05 14:02:16 +05:30
AttachmentsPreview.vue chore: Update buttons in conversation screens(#11132) 2025-03-21 14:47:28 +05:30
AutomationActionInput.vue chore: Update buttons in conversation screens(#11132) 2025-03-21 14:47:28 +05:30
AutomationActionTeamMessageInput.vue chore: Update styles in settings pages (#11070) 2025-03-18 14:40:02 -07:00
AutomationFileInput.vue style: apply fixes for eslint issues [cw-3590] (#10210) 2024-10-03 15:02:12 +05:30
Avatar.vue feat: Eslint rules (#9839) 2024-08-05 14:02:16 +05:30
BackButton.vue chore: Update buttons in integrations page (#11120) 2025-03-20 21:15:47 +05:30
ChannelItem.vue feat: Instagram Inbox using Instagram Business Login (#11054) 2025-04-08 10:47:41 +05:30
ChatTypeTabs.vue feat: Vite + vue 3 💚 (#10047) 2024-10-02 00:36:30 -07:00
ColorPicker.vue style: apply fixes for eslint issues [cw-3590] (#10210) 2024-10-03 15:02:12 +05:30
EmptyState.vue chore: Update styles in settings pages (#11070) 2025-03-18 14:40:02 -07:00
FeatureToggle.vue style: apply fixes for eslint issues [cw-3590] (#10210) 2024-10-03 15:02:12 +05:30
InboxName.vue feat: update colors for v4 (#10660) 2025-01-15 17:13:03 +05:30
LoadingState.vue feat: Eslint rules (#9839) 2024-08-05 14:02:16 +05:30
SettingIntroBanner.vue chore: Update styles in settings pages (#11070) 2025-03-18 14:40:02 -07:00
ShowMore.vue feat: Vite + vue 3 💚 (#10047) 2024-10-02 00:36:30 -07:00
TableFooter.vue style: apply fixes for eslint issues [cw-3590] (#10210) 2024-10-03 15:02:12 +05:30
TableFooterPagination.vue chore: Update buttons in dashboard (#11145) 2025-03-31 17:21:32 -07:00
TableFooterResults.vue feat: Eslint rules (#9839) 2024-08-05 14:02:16 +05:30
TableHeaderCell.vue feat: Update design for report pages (#10506) 2024-11-27 18:10:15 +08:00
Thumbnail.spec.js feat: Improve image loading for thumbnails (#5823) 2022-11-08 21:05:13 -08:00
Thumbnail.vue feat: Don't hide thumbnail on hover (#10935) 2025-02-21 13:50:30 -08:00
ThumbnailGroup.vue feat: Eslint rules (#9839) 2024-08-05 14:02:16 +05:30
UserAvatarWithName.vue feat: Update design for report pages (#10506) 2024-11-27 18:10:15 +08:00
VideoCallButton.vue chore: Update reply editor design (#10575) 2025-01-08 17:49:53 +05:30