> ## Documentation Index
> Fetch the complete documentation index at: https://support.configview.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Intercom setup

Configview reads your Intercom workspace through the Intercom REST API (`https://api.intercom.io`, or the EU or Australian host for those regions), using an **access token** from an app that someone with Developer Hub access creates in Intercom. Configview sends only `GET` requests. It never creates, changes or deletes anything in Intercom.

You will end up with **1 required secret** (`INTERCOM_ACCESS_TOKEN`) and **1 optional secret** (`INTERCOM_REGION`) in Configview when setup is complete.

> **Scope of this integration today.** Configview reads who works in the workspace (teammates, with paid Inbox seat and away mode), your teams and who is in them, the admin activity log for the last 30 days (sign-ins, role, permission and seat changes, token and webhook events, exports), the workspace itself, Help Center settings, and the definitions of your data attributes. It never reads conversations, messages, contacts, leads, companies, tickets, notes, articles, call recordings or transcripts, and it never calls those endpoints.

***

## What the Intercom API does not tell Configview

The teammate list has **no role, permission set, last-active date, 2FA or SSO status**. There is no endpoint for pending invites, API tokens or webhooks: token, webhook and role changes show up only as events in the activity log. Removed teammates are not listed. Configview cannot answer who is an admin or who has gone quiet.

***

## What you need

* An Intercom workspace with access to **Settings > Integrations > Developer Hub**
* The data region of the workspace (US, EU or Australia)

***

## Step 1: Open the Intercom page in Configview

`https://{companyname}.configview.com/admin/integrations/intercom`

## Step 2: Create the token (least privilege)

1. In Intercom open **Settings > Integrations > Developer Hub** and create a new app (an internal integration)
2. Under **Authentication > Permissions** tick **Read admins** only. This covers teammates, teams and the activity log. If the first run reports a 403 for Help Centers or data attributes, tick the matching read-only permission for that area and nothing else
3. Do not tick any conversation, contact, company, ticket, message or write permission
4. Copy the access token. It belongs to the workspace, not to a person, so it keeps working when someone leaves
5. In Configview paste it into `INTERCOM_ACCESS_TOKEN` under **Credentials** and click the save icon
6. If your workspace is hosted in the EU or Australia, set `INTERCOM_REGION` to `eu` or `au`. Leave it empty for the US

## Step 3: Connect and verify

1. Click **Connect**. Configview creates its tables and schedules every collector at your default run time:

| Script | Notes |
| - | - |
| **Workspace** | Name, region, timezone, created date, token owner. |
| **Teammates** | Name, email, job title, Inbox seat, away mode, team count. |
| **Teams** | Team size and assignment method. |
| **Team members** | One row per team membership. |
| **Audit logs** | Admin activity log, last 30 days. |
| **Help centers** | Site settings and whether the public site is on. |
| **Data attributes** | Attribute definitions only, never values. |

2. Click **Verify now**. The health check reads the secret, calls `GET /me`, then reads the teammate list.

If a check fails: **401** means the token was revoked or mistyped (copy it again). **403** means a permission is missing on the app. **429** means the rate limit was hit; retry shortly.

***

## Data Tables

Each table has a `run_at` column and keeps only the newest run.

| Table | Source | Key Columns |
| - | - | - |
| `intercom_workspace` | `GET /me` | app\_id, name, region, timezone, created\_at, identity\_verification, admin\_email |
| `intercom_admins` | `GET /admins` | admin\_id, email, name, job\_title, has\_inbox\_seat, away\_mode\_enabled, team\_count, team\_ids |
| `intercom_teams` | `GET /teams` | team\_id, name, member\_count, distribution\_method, assignment\_limit |
| `intercom_team_members` | `GET /teams` | team\_id, team\_name, admin\_id |
| `intercom_audit_logs` | `GET /admins/activity_logs` | activity\_id, activity\_type, description, actor\_email, actor\_ip, sign\_in\_method, created\_at |
| `intercom_help_centers` | `GET /help_center/help_centers` | help\_center\_id, display\_name, website\_turned\_on, custom\_domain, url\_host |
| `intercom_data_attributes` | `GET /data_attributes` | attribute\_id, model, name, label, data\_type, is\_custom, archived, messenger\_writable |

***

## Rate limits

Intercom allows 10,000 calls per minute per workspace for private apps (25,000 across all apps), counted in 10-second windows. Configview paces at 120 per minute, reads activity logs 150 rows at a time, and retries a 429 after the reset header (60 seconds if none is sent). Each collector makes only a handful of requests.

## Known gaps and things to check on the first run

These come from the published OpenAPI description (version 2.14); no live tenant has been tested yet.

* **Permissions.** Only `read_admins` is documented for teammates and the activity log. Teams, Help Centers and data attributes may each need their own read permission on the app; a 403 is skipped and the table stays empty.
* **Activity log paging.** Configview sends `created_at_after` (30 days back) and follows `pages.next.starting_after`. If the table holds fewer than 150 rows on a busy workspace, check that field.
* **Region.** A token used against the wrong regional host returns 401. Set `INTERCOM_REGION` to match the workspace.
* **Team ids.** `team_ids` on a teammate are numbers and `admin_ids` on a team are numbers, while `id` fields are strings; Configview stores all of them as text and assumes they match.
* **Fin and bot admins.** The teammate list may include non-human admins; they show as accounts without a job title.

## Things worth knowing

**Seats.** A teammate without a paid Inbox seat cannot work conversations; one with a seat and no team receives no team-assigned work.

**Activity log.** Failed and blocked sign-ins, role and seat changes, new tokens and webhooks and data exports are each a query in the catalog and worth a periodic look.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.