Intercom

This documentation for the Intercom integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate Intercom, visit our connection instructions.

Version

This integration utilizes the Intercom REST API v2.

Base URL

The base URL used for all Intercom API endpoints contains the Subdomain:

https:​//api.subdomain.intercom.io

---

Authentication & Authorization

The DataGrail Intercom integration connects using OAuth 2.0.

Scopes

The Intercom integration requires specific scopes that must be granted in order to function for a given capability.

Scope	Access	Deletion	Data Discovery
Read and List users and companies	✅
Read one user and one company	✅
Write users and companies		✅
Read and List Articles			✅
Read tickets			✅
Read conversations			✅
Read and List news items and newsfeeds			✅
Read events			✅

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
GET	/me	Verify connection
POST	https:​//api.intercom.io/auth/eagle/token	Get and refresh access token
GET	https:​//app.intercom.io/oauth	Request authorization

---

Limits

Limits in Intercom are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Access

DataGrail's Intercom integration provides Synchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

1. Search for contacts by the Data Subject email.
2. Extract companies that the contact belongs to.
3. Fetch company details that the contact belongs to.
4. Extract notes associated with the contact.
5. DataGrail will exclude fields "author" and "body" from the collected notes, because these fields may contain personal data of another person.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/companies/company_id	Retrieve a company by ID
POST	/contacts/search	Search contacts
GET	/notes/note_id	Retrieve a note

---

Deletion

DataGrail's Intercom integration provides Synchronous Deletion capabilities for the following supported identifier category: Email.

Data Interactions

For Deletion requests, DataGrail will take the following actions:

1. Search for contacts by the Data Subject email.
2. Delete retrieved contacts by their unique identifiers.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
DEL	/contacts/contacts/contact_id	Delete a contact
POST	/contacts/search	Search contacts

---

Data Discovery

DataGrail's Intercom integration provides data discovery capabilities based on the principle of finding any and all personal data that's stored in a data system.

Data Interactions

For discovery requests, DataGrail will take the following actions:

1. Count the number of all records for supported objects.

Supported Objects

• Contacts
• Articles
• Conversations
• News and Newsfeds
• Notes
• Data Events
• Tickets

2. Fetch example records for each supported object.
3. Sample data for the next analysis and classification.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/companies	Retrieve companies
GET	/contacts	List all contacts
GET	/contacts/search	Search contacts
GET	/data_attributes	List all data attributes