Intercom
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 Cyera 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 |
|---|---|---|
Read and List Articles | ||
Read and List news items and newsfeeds | ||
Read and List users and companies | ✅ | |
Read conversations | ||
Read events | ||
Read one user and one company | ✅ | |
Read tickets | ||
Write users and companies | ✅ |
Endpoints Utilized
Cyera 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.
- Cyera supports requests throttling to stay within 70-80% of specified service rate limits.
- Cyera processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).
Access
Cyera's Intercom integration provides Synchronous Access capabilities for the following supported identifier category: Email.Data Interactions
For Access requests, Cyera will take the following actions:
- Search for contacts by the Data Subject email.
- Extract companies that the contact belongs to.
- Fetch company details that the contact belongs to.
- Extract notes associated with the contact.
- Cyera 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
Cyera's Intercom integration provides Synchronous Deletion capabilities for the following supported identifier category: Email.Data Interactions
For Deletion requests, Cyera will take the following actions:
- Search for contacts by the Data Subject email.
- 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 |
Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.