iachat/spec/factories
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
..
bot_message chore: Handle attachments in Whatsapp Channel (#3299) 2021-11-11 13:03:48 +05:30
captain feat(ee): Add Captain features (#10665) 2025-01-14 16:15:47 -08:00
channel feat: Added the ability to create Instagram channel (#11182) 2025-04-03 13:57:14 +05:30
facebook_message feat: extending lock to single conversation to meta inbox (#9104) 2024-04-03 21:33:23 +05:30
instagram feat: Instagram Inbox using Instagram Business Login (#11054) 2025-04-08 10:47:41 +05:30
instagram_message feat: Add Instagram Channel (#2955) 2021-10-05 14:35:32 +05:30
integrations feat(apps): Shopify Integration (#11101) 2025-03-19 15:37:55 -07:00
twitter chore: upgrade ruby to 3.1.3 (#5555) 2023-01-24 23:55:07 +05:30
account_users.rb Chore: Enable Users to create multiple accounts (#440) 2020-03-07 12:18:16 +05:30
accounts.rb chore: Use feature_flags attribute instead of settings_flags (#6820) 2023-04-04 09:56:58 -07:00
agent_bot_inboxes.rb Feature: Introduce bots (#545) 2020-03-06 01:43:12 +05:30
agent_bots.rb feat: Add backend APIs for the bot metrics (#9031) 2024-03-01 08:20:20 -08:00
applied_slas.rb feat: Add sidekiq jobs to monitor applied SLAs (#8828) 2024-02-07 21:44:56 +04:00
articles.rb fix: Include uncategorized articles in the all article section to allow edit/delete (#10153) 2024-09-23 23:39:03 -07:00
automation_rules.rb chore: Refactor Automation Specs (#6796) 2023-03-30 21:02:52 +05:30
campaigns.rb chore: Campaign ID migration for existing accounts (#2189) 2021-04-30 06:15:24 -07:00
canned_responses.rb Chore: Added tests for canned_responses (#477) 2020-02-08 11:58:40 +05:30
categories.rb feat: Portal endpoint (#4633) 2022-05-16 13:59:59 +05:30
clearbit_response.rb feat: account onboarding with clearbit (#8857) 2024-02-12 23:21:42 +05:30
contact_inbox.rb fix: "wa_source_id" function return value (#5451) 2022-09-29 10:34:55 -07:00
contacts.rb feat: Update API for contact avatar (#4719) 2022-07-12 10:03:16 +02:00
conversation_participants.rb chore: Add controllers for conversation participants (#6462) 2023-02-15 16:33:31 -08:00
conversations.rb feat: Add the ability to un-assign teams using automation (#9668) 2024-06-26 12:40:36 -07:00
csat_survey_responses.rb feat: Add CSAT response APIs (#2503) 2021-06-29 20:59:41 +05:30
custom_attribute_definitions.rb feat: Add APIs for custom attribute definitions (#2689) 2021-07-23 17:04:33 +05:30
custom_filters.rb feat: Add APIs to create custom views on the dashboard (#2498) 2021-06-29 19:29:57 +05:30
custom_roles.rb chore: Fix flaky permissions test (#10074) 2024-09-04 16:13:29 -07:00
dashboard_app.rb feat: Allow users to create dashboard apps to give agents more context (#4761) 2022-06-01 11:13:10 +05:30
data_import.rb feat: Add bulk imports API for contacts (#1724) 2021-02-03 19:24:51 +05:30
email_template.rb feat: Customisable Email Templates (#1095) 2020-08-06 15:21:06 +05:30
folders.rb feat: Portal endpoint (#4633) 2022-05-16 13:59:59 +05:30
inbox_members.rb chore: Ability to Disable Gravatars (#5027) 2022-07-21 19:27:12 +02:00
inboxes.rb chore: Update the behavior of Captain resolutions (#10794) 2025-02-03 16:25:08 +05:30
installation_config.rb feat: installation config in super admin console (#1641) 2021-01-15 13:21:53 +05:30
labels.rb Feature: Improve label experience (#975) 2020-06-25 21:04:03 +05:30
macros.rb feat: Macros CRUD api (#5047) 2022-07-19 17:37:00 +05:30
mentions.rb Feat: custom sort (#4864) 2022-06-22 11:04:42 +05:30
messages.rb chore: Enable the new Rubocop rules (#7122) 2023-05-19 14:37:10 +05:30
notes.rb chore: Add contact note model (#2462) 2021-06-21 15:16:26 +05:30
notification_subscriptions.rb fix: Add catch for additional webpush errors (#9662) 2024-06-21 14:58:36 -07:00
notifications.rb fix: Inbox view Read/Snoozed display filters (#8907) 2024-02-17 13:59:25 +05:30
platform_apps_permissibles.rb feat: Add Platform APIs (#1456) 2021-01-14 20:35:22 +05:30
platform_apps.rb feat: Add Platform APIs (#1456) 2021-01-14 20:35:22 +05:30
portals.rb feat: Portal endpoint (#4633) 2022-05-16 13:59:59 +05:30
related_categories.rb feat: Category API to handle linked categories and parent-sub categories (#4879) 2022-06-28 11:23:20 +05:30
reporting_events.rb feat: Improve Report API performance (#9476) 2024-05-22 17:34:24 -07:00
sla_events.rb feat: add sla events table (#9126) 2024-03-20 11:59:37 +05:30
sla_policies.rb feat: sla 1 - refactor sla_policies model and add applied_sla model (#8602) 2024-01-23 23:48:02 +05:30
super_admins.rb feat: Unify user and super admin credentials (#3830) 2022-01-25 16:58:49 -08:00
team_members.rb feat: Team APIs (#1654) 2021-01-17 23:56:56 +05:30
teams.rb feat: Add new APIs for live reports with team filter (#10994) 2025-02-27 16:11:04 -08:00
users.rb feat: Ability to update avatars from super admin (#7264) 2023-06-09 15:32:24 +05:30
webhooks.rb feat: Add webhook events for contact created, updated (#6415) 2023-02-13 13:28:27 -08:00
working_hours.rb feat: Business hours 2020-11-01 00:14:33 +05:30