You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit fb94698
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: apps/docs/content/docs/integrations/helpscout.mdx
+44-15Lines changed: 44 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,10 +21,13 @@ With the Help Scout block, you can:
21
21
-**Manage customers**: Search, read, create, and update customer profiles.
22
22
-**Look up your account**: List inboxes, folders, users, teams, tags, and workflows.
23
23
-**React to events**: Start workflows when conversations are created, replied to, assigned, tagged, moved, merged, or deleted, or when customers are created or updated.
24
+
-**Build a support knowledge base**: Sync conversations into a knowledge base so agents can search how past issues were resolved.
24
25
25
26
Connect your Help Scout account through OAuth, or save your own Help Scout app as a credential: create an app under **Your Profile > My Apps** (a placeholder redirect URL is fine) and paste its App ID and App Secret. Either way, Sim acts with the permissions of the Help Scout user behind the connection, who needs the **Access API** permission.
26
27
27
-
For triggers, add the Webhooks app in Help Scout (**Settings > Workspace > Apps > Webhooks**), paste the trigger's webhook URL as the callback URL, and enter the same secret key in Help Scout and in the trigger. Sim verifies every delivery's `X-HelpScout-Signature`.
28
+
Triggers need a Help Scout account connected through OAuth. Pick the account (and optionally an inbox) in the trigger and deploy: Sim creates the Help Scout webhook with its own signing secret, verifies every delivery's `X-HelpScout-Signature`, and deletes the webhook when the workflow is undeployed.
29
+
30
+
To search past support history from agents, add Help Scout as a knowledge base source: it syncs conversations and their threads (optionally including internal notes) from one inbox or all of them.
28
31
29
32
In Sim, the Help Scout block lets your agents triage new conversations, draft replies from your knowledge base, keep customer records current, and report on what your support team is handling.
30
33
{/* MANUAL-CONTENT-END */}
@@ -1075,7 +1078,9 @@ Trigger workflow when a user replies to a Help Scout conversation (auto replies
1075
1078
1076
1079
| Parameter | Type | Required | Description |
1077
1080
| --------- | ---- | -------- | ----------- |
1078
-
|`webhookSecret`| string | Yes | The same secret key \(40 characters or fewer\) entered in Help Scout. Sim rejects deliveries whose X-HelpScout-Signature does not match it. |
1081
+
|`triggerCredentials`| string | Yes | Sim creates the Help Scout webhook with this account and deletes it when the workflow is undeployed. |
1082
+
|`triggerMailboxSelector`| project-selector | No | Only receive events for this inbox. Customer events always cover every inbox. |
1083
+
|`triggerMailboxId`| string | No | Inbox ID |
1079
1084
1080
1085
#### Output
1081
1086
@@ -1121,7 +1126,9 @@ Trigger workflow when a Help Scout conversation is assigned
1121
1126
1122
1127
| Parameter | Type | Required | Description |
1123
1128
| --------- | ---- | -------- | ----------- |
1124
-
|`webhookSecret`| string | Yes | The same secret key \(40 characters or fewer\) entered in Help Scout. Sim rejects deliveries whose X-HelpScout-Signature does not match it. |
1129
+
|`triggerCredentials`| string | Yes | Sim creates the Help Scout webhook with this account and deletes it when the workflow is undeployed. |
1130
+
|`triggerMailboxSelector`| project-selector | No | Only receive events for this inbox. Customer events always cover every inbox. |
1131
+
|`triggerMailboxId`| string | No | Inbox ID |
1125
1132
1126
1133
#### Output
1127
1134
@@ -1167,7 +1174,9 @@ Trigger workflow when a conversation is created in Help Scout
1167
1174
1168
1175
| Parameter | Type | Required | Description |
1169
1176
| --------- | ---- | -------- | ----------- |
1170
-
|`webhookSecret`| string | Yes | The same secret key \(40 characters or fewer\) entered in Help Scout. Sim rejects deliveries whose X-HelpScout-Signature does not match it. |
1177
+
|`triggerCredentials`| string | Yes | Sim creates the Help Scout webhook with this account and deletes it when the workflow is undeployed. |
1178
+
|`triggerMailboxSelector`| project-selector | No | Only receive events for this inbox. Customer events always cover every inbox. |
1179
+
|`triggerMailboxId`| string | No | Inbox ID |
1171
1180
1172
1181
#### Output
1173
1182
@@ -1213,7 +1222,9 @@ Trigger workflow when a Help Scout conversation is deleted
1213
1222
1214
1223
| Parameter | Type | Required | Description |
1215
1224
| --------- | ---- | -------- | ----------- |
1216
-
|`webhookSecret`| string | Yes | The same secret key \(40 characters or fewer\) entered in Help Scout. Sim rejects deliveries whose X-HelpScout-Signature does not match it. |
1225
+
|`triggerCredentials`| string | Yes | Sim creates the Help Scout webhook with this account and deletes it when the workflow is undeployed. |
1226
+
|`triggerMailboxSelector`| project-selector | No | Only receive events for this inbox. Customer events always cover every inbox. |
1227
+
|`triggerMailboxId`| string | No | Inbox ID |
1217
1228
1218
1229
#### Output
1219
1230
@@ -1234,7 +1245,9 @@ Trigger workflow when Help Scout conversations are merged
1234
1245
1235
1246
| Parameter | Type | Required | Description |
1236
1247
| --------- | ---- | -------- | ----------- |
1237
-
|`webhookSecret`| string | Yes | The same secret key \(40 characters or fewer\) entered in Help Scout. Sim rejects deliveries whose X-HelpScout-Signature does not match it. |
1248
+
|`triggerCredentials`| string | Yes | Sim creates the Help Scout webhook with this account and deletes it when the workflow is undeployed. |
1249
+
|`triggerMailboxSelector`| project-selector | No | Only receive events for this inbox. Customer events always cover every inbox. |
1250
+
|`triggerMailboxId`| string | No | Inbox ID |
1238
1251
1239
1252
#### Output
1240
1253
@@ -1280,7 +1293,9 @@ Trigger workflow when a Help Scout conversation is moved to another inbox
1280
1293
1281
1294
| Parameter | Type | Required | Description |
1282
1295
| --------- | ---- | -------- | ----------- |
1283
-
|`webhookSecret`| string | Yes | The same secret key \(40 characters or fewer\) entered in Help Scout. Sim rejects deliveries whose X-HelpScout-Signature does not match it. |
1296
+
|`triggerCredentials`| string | Yes | Sim creates the Help Scout webhook with this account and deletes it when the workflow is undeployed. |
1297
+
|`triggerMailboxSelector`| project-selector | No | Only receive events for this inbox. Customer events always cover every inbox. |
1298
+
|`triggerMailboxId`| string | No | Inbox ID |
1284
1299
1285
1300
#### Output
1286
1301
@@ -1326,7 +1341,9 @@ Trigger workflow when the status of a Help Scout conversation changes
1326
1341
1327
1342
| Parameter | Type | Required | Description |
1328
1343
| --------- | ---- | -------- | ----------- |
1329
-
|`webhookSecret`| string | Yes | The same secret key \(40 characters or fewer\) entered in Help Scout. Sim rejects deliveries whose X-HelpScout-Signature does not match it. |
1344
+
|`triggerCredentials`| string | Yes | Sim creates the Help Scout webhook with this account and deletes it when the workflow is undeployed. |
1345
+
|`triggerMailboxSelector`| project-selector | No | Only receive events for this inbox. Customer events always cover every inbox. |
1346
+
|`triggerMailboxId`| string | No | Inbox ID |
1330
1347
1331
1348
#### Output
1332
1349
@@ -1372,7 +1389,9 @@ Trigger workflow when the tags on a Help Scout conversation change
1372
1389
1373
1390
| Parameter | Type | Required | Description |
1374
1391
| --------- | ---- | -------- | ----------- |
1375
-
|`webhookSecret`| string | Yes | The same secret key \(40 characters or fewer\) entered in Help Scout. Sim rejects deliveries whose X-HelpScout-Signature does not match it. |
1392
+
|`triggerCredentials`| string | Yes | Sim creates the Help Scout webhook with this account and deletes it when the workflow is undeployed. |
1393
+
|`triggerMailboxSelector`| project-selector | No | Only receive events for this inbox. Customer events always cover every inbox. |
1394
+
|`triggerMailboxId`| string | No | Inbox ID |
1376
1395
1377
1396
#### Output
1378
1397
@@ -1418,7 +1437,9 @@ Trigger workflow when a customer is created in Help Scout (fires for every inbox
1418
1437
1419
1438
| Parameter | Type | Required | Description |
1420
1439
| --------- | ---- | -------- | ----------- |
1421
-
|`webhookSecret`| string | Yes | The same secret key \(40 characters or fewer\) entered in Help Scout. Sim rejects deliveries whose X-HelpScout-Signature does not match it. |
1440
+
|`triggerCredentials`| string | Yes | Sim creates the Help Scout webhook with this account and deletes it when the workflow is undeployed. |
1441
+
|`triggerMailboxSelector`| project-selector | No | Only receive events for this inbox. Customer events always cover every inbox. |
1442
+
|`triggerMailboxId`| string | No | Inbox ID |
1422
1443
1423
1444
#### Output
1424
1445
@@ -1461,7 +1482,9 @@ Trigger workflow when a customer replies to a Help Scout conversation
1461
1482
1462
1483
| Parameter | Type | Required | Description |
1463
1484
| --------- | ---- | -------- | ----------- |
1464
-
|`webhookSecret`| string | Yes | The same secret key \(40 characters or fewer\) entered in Help Scout. Sim rejects deliveries whose X-HelpScout-Signature does not match it. |
1485
+
|`triggerCredentials`| string | Yes | Sim creates the Help Scout webhook with this account and deletes it when the workflow is undeployed. |
1486
+
|`triggerMailboxSelector`| project-selector | No | Only receive events for this inbox. Customer events always cover every inbox. |
1487
+
|`triggerMailboxId`| string | No | Inbox ID |
1465
1488
1466
1489
#### Output
1467
1490
@@ -1507,7 +1530,9 @@ Trigger workflow when a Help Scout customer is updated
1507
1530
1508
1531
| Parameter | Type | Required | Description |
1509
1532
| --------- | ---- | -------- | ----------- |
1510
-
|`webhookSecret`| string | Yes | The same secret key \(40 characters or fewer\) entered in Help Scout. Sim rejects deliveries whose X-HelpScout-Signature does not match it. |
1533
+
|`triggerCredentials`| string | Yes | Sim creates the Help Scout webhook with this account and deletes it when the workflow is undeployed. |
1534
+
|`triggerMailboxSelector`| project-selector | No | Only receive events for this inbox. Customer events always cover every inbox. |
1535
+
|`triggerMailboxId`| string | No | Inbox ID |
1511
1536
1512
1537
#### Output
1513
1538
@@ -1550,7 +1575,9 @@ Trigger workflow when a note is added to a Help Scout conversation
1550
1575
1551
1576
| Parameter | Type | Required | Description |
1552
1577
| --------- | ---- | -------- | ----------- |
1553
-
|`webhookSecret`| string | Yes | The same secret key \(40 characters or fewer\) entered in Help Scout. Sim rejects deliveries whose X-HelpScout-Signature does not match it. |
1578
+
|`triggerCredentials`| string | Yes | Sim creates the Help Scout webhook with this account and deletes it when the workflow is undeployed. |
1579
+
|`triggerMailboxSelector`| project-selector | No | Only receive events for this inbox. Customer events always cover every inbox. |
1580
+
|`triggerMailboxId`| string | No | Inbox ID |
1554
1581
1555
1582
#### Output
1556
1583
@@ -1590,13 +1617,15 @@ Trigger workflow when a note is added to a Help Scout conversation
1590
1617
1591
1618
### Help Scout Webhook (All Selected Events)
1592
1619
1593
-
Trigger on every event selected for this URL in Help Scout. Sim does not filter deliveries for this trigger.
1620
+
Trigger on every supported Help Scout conversation and customer event
1594
1621
1595
1622
#### Configuration
1596
1623
1597
1624
| Parameter | Type | Required | Description |
1598
1625
| --------- | ---- | -------- | ----------- |
1599
-
|`webhookSecret`| string | Yes | The same secret key \(40 characters or fewer\) entered in Help Scout. Sim rejects deliveries whose X-HelpScout-Signature does not match it. |
1626
+
|`triggerCredentials`| string | Yes | Sim creates the Help Scout webhook with this account and deletes it when the workflow is undeployed. |
1627
+
|`triggerMailboxSelector`| project-selector | No | Only receive events for this inbox. Customer events always cover every inbox. |
0 commit comments