Skip to content

Commit fb94698

Browse files
committed
feat(helpscout): add knowledge base connector and auto-registered webhook triggers
1 parent 796b9a8 commit fb94698

22 files changed

Lines changed: 766 additions & 62 deletions

‎apps/docs/content/docs/integrations/helpscout.mdx‎

Lines changed: 44 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,13 @@ With the Help Scout block, you can:
2121
- **Manage customers**: Search, read, create, and update customer profiles.
2222
- **Look up your account**: List inboxes, folders, users, teams, tags, and workflows.
2323
- **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.
2425

2526
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.
2627

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.
2831

2932
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.
3033
{/* MANUAL-CONTENT-END */}
@@ -1075,7 +1078,9 @@ Trigger workflow when a user replies to a Help Scout conversation (auto replies
10751078

10761079
| Parameter | Type | Required | Description |
10771080
| --------- | ---- | -------- | ----------- |
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 |
10791084

10801085
#### Output
10811086

@@ -1121,7 +1126,9 @@ Trigger workflow when a Help Scout conversation is assigned
11211126

11221127
| Parameter | Type | Required | Description |
11231128
| --------- | ---- | -------- | ----------- |
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 |
11251132

11261133
#### Output
11271134

@@ -1167,7 +1174,9 @@ Trigger workflow when a conversation is created in Help Scout
11671174

11681175
| Parameter | Type | Required | Description |
11691176
| --------- | ---- | -------- | ----------- |
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 |
11711180

11721181
#### Output
11731182

@@ -1213,7 +1222,9 @@ Trigger workflow when a Help Scout conversation is deleted
12131222

12141223
| Parameter | Type | Required | Description |
12151224
| --------- | ---- | -------- | ----------- |
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 |
12171228

12181229
#### Output
12191230

@@ -1234,7 +1245,9 @@ Trigger workflow when Help Scout conversations are merged
12341245

12351246
| Parameter | Type | Required | Description |
12361247
| --------- | ---- | -------- | ----------- |
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 |
12381251

12391252
#### Output
12401253

@@ -1280,7 +1293,9 @@ Trigger workflow when a Help Scout conversation is moved to another inbox
12801293

12811294
| Parameter | Type | Required | Description |
12821295
| --------- | ---- | -------- | ----------- |
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 |
12841299

12851300
#### Output
12861301

@@ -1326,7 +1341,9 @@ Trigger workflow when the status of a Help Scout conversation changes
13261341

13271342
| Parameter | Type | Required | Description |
13281343
| --------- | ---- | -------- | ----------- |
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 |
13301347

13311348
#### Output
13321349

@@ -1372,7 +1389,9 @@ Trigger workflow when the tags on a Help Scout conversation change
13721389

13731390
| Parameter | Type | Required | Description |
13741391
| --------- | ---- | -------- | ----------- |
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 |
13761395

13771396
#### Output
13781397

@@ -1418,7 +1437,9 @@ Trigger workflow when a customer is created in Help Scout (fires for every inbox
14181437

14191438
| Parameter | Type | Required | Description |
14201439
| --------- | ---- | -------- | ----------- |
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 |
14221443

14231444
#### Output
14241445

@@ -1461,7 +1482,9 @@ Trigger workflow when a customer replies to a Help Scout conversation
14611482

14621483
| Parameter | Type | Required | Description |
14631484
| --------- | ---- | -------- | ----------- |
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 |
14651488

14661489
#### Output
14671490

@@ -1507,7 +1530,9 @@ Trigger workflow when a Help Scout customer is updated
15071530

15081531
| Parameter | Type | Required | Description |
15091532
| --------- | ---- | -------- | ----------- |
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 |
15111536

15121537
#### Output
15131538

@@ -1550,7 +1575,9 @@ Trigger workflow when a note is added to a Help Scout conversation
15501575

15511576
| Parameter | Type | Required | Description |
15521577
| --------- | ---- | -------- | ----------- |
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 |
15541581

15551582
#### Output
15561583

@@ -1590,13 +1617,15 @@ Trigger workflow when a note is added to a Help Scout conversation
15901617

15911618
### Help Scout Webhook (All Selected Events)
15921619

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
15941621

15951622
#### Configuration
15961623

15971624
| Parameter | Type | Required | Description |
15981625
| --------- | ---- | -------- | ----------- |
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. |
1628+
| `triggerMailboxId` | string | No | Inbox ID |
16001629

16011630
#### Output
16021631

0 commit comments

Comments
 (0)