enhancementgood first issueintegrationnew-featurenew-integration
Repository metrics
- Stars
- (1,930 stars)
- PR merge metrics
- (PR metrics pending)
Description
Description
Add Intercom integration to sync customer conversations, contacts, companies, and help center articles into CORE.
Reference Implementations
Existing Integrations (use as templates)
integrations/hubspot/- Similar CRM/customer platformintegrations/slack/- Messaging and conversation sync referenceintegrations/linear/- Project management integration
Required Files Structure
integrations/intercom/
├── src/
│ ├── index.ts # Main entry, OAuth spec
│ ├── schedule.ts # Sync logic
│ ├── utils.ts # Intercom API utilities
│ ├── account-create.ts # OAuth setup
│ └── create-activity.ts # Activity formatting
├── package.json
├── tsup.config.ts
└── README.md
Intercom API Integration
OAuth Setup
- Use OAuth 2.0
- Current API version: 2.15
- Set API version via
Intercom-VersionHTTP header - Required scopes: Conversations, Contacts, Companies, Help Center, Data Events
- Base URL:
https://api.intercom.io
Key Endpoints
GET /conversations- List all conversationsGET /conversations/{id}- Get a specific conversationGET /contacts- List/search contactsGET /contacts/{id}- Get a specific contactGET /companies- List all companiesGET /articles- List help center articlesGET /admins- List all admins/teammatesGET /data_events- List data events for a userGET /teams- List all teamsGET /tags- List all tags
Events to Track
- Conversations - New conversations, replies, assignments, closures, reopens
- Contacts - New leads, new users, contact updates
- Companies - New companies, updates
- Articles - Published, updated help center articles
- Notes - Notes added to contacts
Implementation Tasks
- Set up basic integration structure following
integrations/github/src/index.tspattern - Implement OAuth 2.0 flow in
account-create.ts - Create API utilities in
utils.tswith Intercom API v2.15 client - Implement sync logic in
schedule.tsfor conversations, contacts, companies - Convert Intercom events to CORE activity format
- Add error handling and rate limiting
- Create integration documentation
- Add to
integrations/README.md
Technical Notes
- REST API v2.15 is the latest version
- Version must be set via
Intercom-Versionheader on each request - OpenAPI specification available at github.com/intercom/Intercom-OpenAPI
- Supports webhooks for real-time event notifications
- Pagination uses cursor-based pagination
- Rate limits apply per app
- Intercom provides scroll API for bulk data export
Resources
- Intercom API v2.15 Reference
- Intercom REST API Overview
- Intercom Developers Portal
- API Changelog
- Intercom OpenAPI Spec
Labels
enhancement, integration, new-feature