@rawdash/connector-intercom 0.0.1 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/README.md +90 -141
- package/dist/index.d.ts +427 -3
- package/dist/index.js +163 -11
- package/dist/index.js.map +1 -1
- package/package.json +14 -13
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,75 +1,99 @@
|
|
|
1
|
+
<!-- This file is generated from connector metadata by scripts/generate-connector-docs.ts. Do not edit by hand. -->
|
|
2
|
+
|
|
1
3
|
# @rawdash/connector-intercom
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
[](https://www.npmjs.com/package/@rawdash/connector-intercom)
|
|
6
|
+
[](https://github.com/rawdash/rawdash/blob/main/LICENSE)
|
|
7
|
+
|
|
8
|
+
Sync conversations, contacts, teams, and admins from Intercom for support volume, response latency, and queue-depth analytics.
|
|
4
9
|
|
|
5
|
-
##
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
```sh
|
|
13
|
+
npm install @rawdash/connector-intercom
|
|
14
|
+
```
|
|
6
15
|
|
|
7
|
-
|
|
16
|
+
## Authentication
|
|
8
17
|
|
|
9
|
-
|
|
10
|
-
2. Either create a new app or open an existing one.
|
|
11
|
-
3. On the app's **Authentication** tab, copy the **Access token**.
|
|
12
|
-
4. Make sure the token has read access for the resources you want to sync (conversations, contacts, admins, teams).
|
|
18
|
+
An Intercom access token (personal or app) with read access to conversations, contacts, teams, and admins.
|
|
13
19
|
|
|
14
|
-
|
|
20
|
+
1. Open Intercom → Settings → Developers → Developer Hub and create or select an app.
|
|
21
|
+
2. On the app's Authentication tab, copy the access token.
|
|
22
|
+
3. Ensure the token has read access for the resources you intend to sync.
|
|
23
|
+
4. Store the token as a secret and reference it from config as `accessToken: secret("INTERCOM_ACCESS_TOKEN")`.
|
|
15
24
|
|
|
16
25
|
## Configuration
|
|
17
26
|
|
|
27
|
+
| Field | Type | Required | Description |
|
|
28
|
+
| ------------- | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
29
|
+
| `accessToken` | secret | Yes | Intercom access token (personal or app) with read access to conversations, contacts, teams, and admins. Generate one at Settings → Developers → Developer Hub → Authentication. |
|
|
30
|
+
| `apiVersion` | string | No | Value sent in the Intercom-Version header. Defaults to 2.11; pin a specific version here when upgrading deliberately. |
|
|
31
|
+
| `region` | `us` \| `eu` \| `au` | No | Intercom region of your workspace. Selects the API host: us → api.intercom.io, eu → api.eu.intercom.io, au → api.au.intercom.io. |
|
|
32
|
+
| `resources` | array | No | Which Intercom resources to sync. Omit to sync all of them. The access token only needs read scopes for the resources listed here. |
|
|
33
|
+
|
|
34
|
+
## Resources
|
|
35
|
+
|
|
36
|
+
- **`intercom_admin`** _(entity)_ - Intercom teammates (admins) with seat and away state.
|
|
37
|
+
- Endpoint: `GET /admins`
|
|
38
|
+
- `name`: Admin display name.
|
|
39
|
+
- `email`: Admin email address.
|
|
40
|
+
- `jobTitle`: Admin job title.
|
|
41
|
+
- `awayMode`: Whether away mode is enabled.
|
|
42
|
+
- `hasInboxSeat`: Whether the admin has an inbox seat.
|
|
43
|
+
- **`intercom_team`** _(entity)_ - Inbox teams and their admin membership counts.
|
|
44
|
+
- Endpoint: `GET /teams`
|
|
45
|
+
- `name`: Team name.
|
|
46
|
+
- `adminCount`: Number of admins on the team.
|
|
47
|
+
- **`intercom_contact`** _(entity)_ - Contacts (users and leads) with role and last-seen time.
|
|
48
|
+
- Endpoint: `POST /contacts/search`
|
|
49
|
+
- `role`: Contact role (user or lead).
|
|
50
|
+
- `email`: Contact email address.
|
|
51
|
+
- `externalId`: Your external identifier for the contact.
|
|
52
|
+
- `createdAt`: When the contact was created (Unix ms).
|
|
53
|
+
- `lastSeenAt`: When the contact was last seen (Unix ms).
|
|
54
|
+
- **`intercom_conversation`** _(entity)_ - Conversations with state, priority, assignment, reply-time statistics, and tags.
|
|
55
|
+
- Endpoint: `POST /conversations/search`
|
|
56
|
+
- `state`: Conversation state (open, snoozed, closed).
|
|
57
|
+
- `priority`: Conversation priority.
|
|
58
|
+
- `adminAssigneeId`: Assigned admin id (null if unassigned).
|
|
59
|
+
- `teamAssigneeId`: Assigned team id (null if unassigned).
|
|
60
|
+
- `createdAt`: When the conversation was created (Unix ms).
|
|
61
|
+
- `firstContactReplyAt`: First contact reply time (Unix ms).
|
|
62
|
+
- `firstAdminReplyAt`: First admin reply time (Unix ms).
|
|
63
|
+
- `snoozedUntil`: Snooze expiry time (Unix ms), if snoozed.
|
|
64
|
+
- `countAssignments`: Number of assignments.
|
|
65
|
+
- `countReopens`: Number of reopens.
|
|
66
|
+
- `countConversationParts`: Number of conversation parts.
|
|
67
|
+
- `tags`: Flat list of tag names on the conversation.
|
|
68
|
+
- **`intercom_conversation_state_change`** _(event)_ - State-change events (created / assigned / closed / snoozed) derived from each conversation.
|
|
69
|
+
- Endpoint: `POST /conversations/search`
|
|
70
|
+
- Derived from each conversation’s statistics block; the scope is cleared and rewritten on every sync.
|
|
71
|
+
- `conversationId`: The conversation the event belongs to.
|
|
72
|
+
- `transition`: created, assigned, closed, or snoozed.
|
|
73
|
+
- `state`: Conversation state at sync time.
|
|
74
|
+
- `priority`: Conversation priority at sync time.
|
|
75
|
+
- `adminAssigneeId`: Assigned admin id (null if unassigned).
|
|
76
|
+
- `teamAssigneeId`: Assigned team id (null if unassigned).
|
|
77
|
+
|
|
78
|
+
## Example
|
|
79
|
+
|
|
18
80
|
```ts
|
|
19
|
-
import {
|
|
81
|
+
import {
|
|
82
|
+
defineConfig,
|
|
83
|
+
defineDashboard,
|
|
84
|
+
defineMetric,
|
|
85
|
+
secret,
|
|
86
|
+
} from '@rawdash/core';
|
|
20
87
|
|
|
21
88
|
const intercom = {
|
|
22
89
|
name: 'intercom',
|
|
23
90
|
connectorId: 'intercom',
|
|
24
91
|
config: {
|
|
25
92
|
accessToken: secret('INTERCOM_ACCESS_TOKEN'),
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
// resources: ['conversations', 'admins'], // optional, defaults to all
|
|
93
|
+
region: 'us',
|
|
94
|
+
apiVersion: '2.11',
|
|
29
95
|
},
|
|
30
96
|
};
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
Register the connector class when mounting the engine:
|
|
34
|
-
|
|
35
|
-
```ts
|
|
36
|
-
import { IntercomConnector } from '@rawdash/connector-intercom';
|
|
37
|
-
import { mountEngine } from '@rawdash/hono';
|
|
38
|
-
|
|
39
|
-
mountEngine(config, { connectorRegistry: { intercom: IntercomConnector } });
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
### Region
|
|
43
|
-
|
|
44
|
-
Set `region` to match the data residency of your Intercom workspace. The connector routes every request to the matching host:
|
|
45
|
-
|
|
46
|
-
| `region` | Host |
|
|
47
|
-
| -------- | ---------------------------- |
|
|
48
|
-
| `us` | `https://api.intercom.io` |
|
|
49
|
-
| `eu` | `https://api.eu.intercom.io` |
|
|
50
|
-
| `au` | `https://api.au.intercom.io` |
|
|
51
|
-
|
|
52
|
-
### Choosing resources
|
|
53
|
-
|
|
54
|
-
By default the connector syncs every supported resource. Pass `resources` to sync only a subset:
|
|
55
|
-
|
|
56
|
-
`admins`, `teams`, `contacts`, `conversations`, `conversation_events`
|
|
57
|
-
|
|
58
|
-
The access token only needs read scopes for the resources you list. `conversation_events` is derived from the same `/conversations/search` payload as `conversations`; disable it to skip the second pass.
|
|
59
|
-
|
|
60
|
-
### Configuration reference
|
|
61
|
-
|
|
62
|
-
| Field | Required | Description |
|
|
63
|
-
| ------------- | -------- | ------------------------------------------------------------------------------ |
|
|
64
|
-
| `accessToken` | yes | Intercom access token (secret). Bearer-authenticated. |
|
|
65
|
-
| `region` | no | Intercom region: `us`, `eu`, or `au`. Defaults to `us`. |
|
|
66
|
-
| `apiVersion` | no | Value sent in the `Intercom-Version` header (e.g. `2.11`). Defaults to `2.11`. |
|
|
67
|
-
| `resources` | no | Subset of resources to sync. Omit for all. |
|
|
68
|
-
|
|
69
|
-
### Example dashboard
|
|
70
|
-
|
|
71
|
-
```ts
|
|
72
|
-
import { defineConfig, defineDashboard, defineMetric } from '@rawdash/core';
|
|
73
97
|
|
|
74
98
|
export default defineConfig({
|
|
75
99
|
connectors: [intercom],
|
|
@@ -87,103 +111,28 @@ export default defineConfig({
|
|
|
87
111
|
filter: [{ field: 'state', op: 'eq', value: 'open' }],
|
|
88
112
|
}),
|
|
89
113
|
},
|
|
90
|
-
conversations_today: {
|
|
91
|
-
kind: 'stat',
|
|
92
|
-
title: 'Conversations today',
|
|
93
|
-
metric: defineMetric({
|
|
94
|
-
connector: intercom,
|
|
95
|
-
shape: 'event',
|
|
96
|
-
name: 'intercom_conversation_state_change',
|
|
97
|
-
field: 'start_ts',
|
|
98
|
-
fn: 'count',
|
|
99
|
-
window: '1d',
|
|
100
|
-
filter: [{ field: 'transition', op: 'eq', value: 'created' }],
|
|
101
|
-
}),
|
|
102
|
-
},
|
|
103
|
-
conversation_volume: {
|
|
104
|
-
kind: 'timeseries',
|
|
105
|
-
title: 'Conversation volume (7d)',
|
|
106
|
-
window: '7d',
|
|
107
|
-
metric: defineMetric({
|
|
108
|
-
connector: intercom,
|
|
109
|
-
shape: 'event',
|
|
110
|
-
name: 'intercom_conversation_state_change',
|
|
111
|
-
field: 'start_ts',
|
|
112
|
-
fn: 'count',
|
|
113
|
-
window: '7d',
|
|
114
|
-
filter: [{ field: 'transition', op: 'eq', value: 'created' }],
|
|
115
|
-
groupBy: { field: 'start_ts', granularity: 'day' },
|
|
116
|
-
}),
|
|
117
|
-
},
|
|
118
|
-
conversations_by_team: {
|
|
119
|
-
kind: 'distribution',
|
|
120
|
-
title: 'Open conversations by team',
|
|
121
|
-
metric: defineMetric({
|
|
122
|
-
connector: intercom,
|
|
123
|
-
shape: 'entity',
|
|
124
|
-
entityType: 'intercom_conversation',
|
|
125
|
-
fn: 'count',
|
|
126
|
-
filter: [{ field: 'state', op: 'eq', value: 'open' }],
|
|
127
|
-
groupBy: { field: 'teamAssigneeId' },
|
|
128
|
-
}),
|
|
129
|
-
},
|
|
130
114
|
},
|
|
131
115
|
}),
|
|
132
116
|
},
|
|
133
117
|
});
|
|
134
118
|
```
|
|
135
119
|
|
|
136
|
-
##
|
|
137
|
-
|
|
138
|
-
Timestamps stored in attributes are Unix milliseconds (Intercom returns Unix seconds; the connector multiplies by 1000 at write time).
|
|
139
|
-
|
|
140
|
-
| Storage shape | Entity/event type | Key attributes |
|
|
141
|
-
| ------------- | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |
|
|
142
|
-
| entity | `intercom_admin` | name, email, jobTitle, awayMode, hasInboxSeat |
|
|
143
|
-
| entity | `intercom_team` | name, adminCount |
|
|
144
|
-
| entity | `intercom_contact` | role, email, externalId, createdAt, lastSeenAt |
|
|
145
|
-
| entity | `intercom_conversation` | state, priority, adminAssigneeId, teamAssigneeId, createdAt, firstContactReplyAt, firstAdminReplyAt, snoozedUntil, count\*, tags[] |
|
|
146
|
-
| event | `intercom_conversation_state_change` | conversationId, transition (`created` / `assigned` / `closed` / `snoozed`), state, priority, adminAssigneeId, teamAssigneeId |
|
|
147
|
-
|
|
148
|
-
- **`intercom_conversation_state_change`** events are derived from the conversation's `statistics` block — one event per known transition timestamp (`created_at`, `last_assignment_at`, `last_close_at`, and `snoozed_until` when the conversation is currently snoozed). The event scope is cleared and rewritten on every sync, so each tick produces the latest snapshot of those transitions per conversation. Full per-part transition history requires a separate `/conversations/{id}` fetch and is intentionally out of scope for v0.1.
|
|
149
|
-
- **`intercom_conversation`** carries the rolled-up statistics (`countAssignments`, `countReopens`, `countConversationParts`) and tag names so distribution widgets can group by tag without a join.
|
|
150
|
-
|
|
151
|
-
## Schemas
|
|
120
|
+
## Rate limits
|
|
152
121
|
|
|
153
|
-
|
|
122
|
+
Intercom enforces per-app and per-workspace limits (default ~1000 requests/minute) and signals quota state via the X-RateLimit-\* response headers; the shared HTTP client backs off on 429, preferring X-RateLimit-Reset.
|
|
154
123
|
|
|
155
|
-
##
|
|
124
|
+
## Limitations
|
|
156
125
|
|
|
157
|
-
-
|
|
158
|
-
-
|
|
159
|
-
-
|
|
160
|
-
- **Rate limits**: Intercom enforces per-app and per-workspace limits (the default is ~1000 requests/minute; see [Intercom's rate-limiting docs](https://developers.intercom.com/docs/references/rest-api/errors/rate-limiting) for current values) and signals quota state through the `X-RateLimit-*` response headers — notably `X-RateLimit-Reset`, a UNIX timestamp for when the window resets. On `429` the shared HTTP client backs off and retries, preferring `X-RateLimit-Reset` when present.
|
|
161
|
-
|
|
162
|
-
## Registering in the MCP server
|
|
163
|
-
|
|
164
|
-
To make the connector available via the `add_connector` MCP tool, include it in `connectorFactories`:
|
|
165
|
-
|
|
166
|
-
```ts
|
|
167
|
-
import { IntercomConnector, configFields } from '@rawdash/connector-intercom';
|
|
168
|
-
|
|
169
|
-
createMcpServer({
|
|
170
|
-
// ...
|
|
171
|
-
connectorFactories: [
|
|
172
|
-
{
|
|
173
|
-
id: 'intercom',
|
|
174
|
-
configFields,
|
|
175
|
-
create: IntercomConnector.create,
|
|
176
|
-
},
|
|
177
|
-
],
|
|
178
|
-
});
|
|
179
|
-
```
|
|
126
|
+
- Conversation message bodies and per-part transcripts are not synced.
|
|
127
|
+
- Help Center articles and outbound campaigns are out of scope.
|
|
128
|
+
- Full per-part state-transition history is not synced; state-change events are derived from each conversation’s statistics block.
|
|
180
129
|
|
|
181
|
-
##
|
|
130
|
+
## Links
|
|
182
131
|
|
|
183
|
-
|
|
132
|
+
- [Rawdash docs](https://rawdash.dev/docs/connectors/)
|
|
133
|
+
- [Intercom API docs](https://developers.intercom.com/docs/references/rest-api/api.intercom.io/)
|
|
134
|
+
- [GitHub](https://github.com/rawdash/rawdash)
|
|
184
135
|
|
|
185
|
-
##
|
|
136
|
+
## License
|
|
186
137
|
|
|
187
|
-
-
|
|
188
|
-
- Help Center articles, knowledge base content, and outbound campaigns — covered by separate Intercom APIs that don't aggregate well.
|
|
189
|
-
- Full per-part state-transition history — would require an extra `GET /conversations/{id}` call per conversation and is deferred.
|
|
138
|
+
Apache-2.0
|