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
Copy file name to clipboardExpand all lines: apps/docs/content/docs/en/integrations/harmonic.mdx
+6-9Lines changed: 6 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,14 +15,15 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
15
15
16
16
### Authentication
17
17
18
-
This integration uses a Harmonic **team API key**, sent only in the `apikey` request header. It does not use OAuth. You need an existing Harmonic workspace with API access; ask your Harmonic workspace administrator or [Harmonic support](mailto:support@harmonic.ai) for the team key, then paste it into the block's **Harmonic API Key** field.
18
+
This integration uses a reusable Harmonic **team API key** connection. It does not use delegated OAuth. You need an existing Harmonic workspace with API access; ask your Harmonic workspace administrator or [Harmonic support](mailto:support@harmonic.ai) for the team key, then create a Harmonic connection from the block's **Harmonic Account** field. Sim validates and stores the key once, then sends it only in Harmonic's `apikey` request header. The same connection can be reused across Harmonic blocks and replaced or revoked from the credentials settings.
19
19
20
20
### Working with people data
21
21
22
22
-**Scout search:****Search People with Scout** uses an integration-owned schema so every successful request returns the same normalized contact fields. Scout task errors, timeouts, interruptions, and malformed structured results stop the workflow instead of returning an ambiguous partial result.
23
-
-**Saved searches:** A team API key can read only saved searches shared with the team. Make a private people search shared in the Harmonic console before retrieving it through the API. Follow `pageInfo.nextCursor` while `pageInfo.hasNext` is true.
23
+
-**Saved searches:** A team API key can read only saved searches shared with the team. Make a private people search shared in the Harmonic console, then choose it with the basic selector. Advanced mode accepts a numeric saved-search ID or full URN when a search is not shown. Follow `pageInfo.nextCursor` while `pageInfo.hasNext` is true.
24
24
-**URN-only rows:** Saved-search pages may contain person URNs without full profiles. Pass `personUrns` to **Batch Get People** to hydrate them into the common contact shape.
25
-
-**Downstream workflows:** Pass `contacts` directly into Sim tables, scoring or approval steps, and other integrations such as a CRM. Every contact-producing action uses the same camelCase output shape.
25
+
-**Downstream workflows:** Pass `contacts` directly into Sim tables, scoring or approval steps, and other integrations such as a CRM. Every contact-producing action uses the same camelCase output shape. A nullable array means Harmonic did not return that collection for the record; an empty array means Harmonic returned the collection with no values.
26
+
-**Large batches:** Batch Get People accepts at most 500 combined IDs and URNs and requests only the fields used by the normalized contact output. Exceptionally large profiles can still exceed Sim's response limit; retry with smaller batches if that occurs.
26
27
-**Workspace and list APIs:** This first version intentionally omits Harmonic's retiring V1 workspace and people-list endpoints. Harmonic says those APIs stop serving traffic on November 5, 2026 and already fail after a workspace completes its V2 migration. See Harmonic's [Workspace API migration guide](https://console.harmonic.ai/docs/api-reference/workspace/migration) for the V2 GraphQL replacement.
27
28
28
29
Harmonic recommends no more than 100 saved-search results per page. Its general API limit is 10 requests per second, while Scout task creation is limited to 10 requests per minute and 100 per hour. Endpoint and field availability can also depend on your Harmonic subscription.
@@ -33,7 +34,7 @@ Harmonic does not publish a webhook-registration contract for this workflow surf
33
34
34
35
## Usage Instructions
35
36
36
-
Use Harmonic Scout to find people with natural-language criteria, retrieve team-visible people saved searches, and hydrate person identifiers into normalized contacts for downstream tables, CRM, scoring, and outreach workflows.
37
+
Connect a reusable Harmonic team API key, use Scout to find people with natural-language criteria, select team-visible people saved searches, and hydrate person identifiers into normalized contacts for downstream tables, CRM, scoring, and outreach workflows.
37
38
38
39
39
40
@@ -47,7 +48,6 @@ Ask Harmonic Scout to find people using natural language and return a stable, wo
47
48
48
49
| Parameter | Type | Required | Description |
49
50
| --------- | ---- | -------- | ----------- |
50
-
|`apiKey`| string | Yes | Harmonic team API key, sent in the apikey header |
51
51
|`query`| string | Yes | Natural-language people research request, e.g. "Find forward-deployed engineers in enterprise software" |
52
52
53
53
#### Output
@@ -87,7 +87,6 @@ List the team-shared Harmonic saved searches that target people. Use a returned
87
87
88
88
| Parameter | Type | Required | Description |
89
89
| --------- | ---- | -------- | ----------- |
90
-
|`apiKey`| string | Yes | Harmonic team API key, sent in the apikey header |
91
90
92
91
#### Output
93
92
@@ -98,7 +97,7 @@ List the team-shared Harmonic saved searches that target people. Use a returned
98
97
| ↳ `savedSearchUrn`| string | Saved search URN |
99
98
| ↳ `name`| string | Saved search name |
100
99
| ↳ `isPrivate`| boolean | Whether the search is private |
101
-
| ↳ `savedSearchType`| string | Saved search entity type |
100
+
| ↳ `savedSearchType`| string | Saved search entity type \(PERSONS\)|
102
101
| ↳ `userSavedSearchType`| string | User-facing saved search type |
103
102
| ↳ `creatorUrn`| string | Creator user URN |
104
103
| ↳ `createdAt`| string | Creation timestamp |
@@ -113,7 +112,6 @@ Get one page of a Harmonic people saved search. Full records become contacts; UR
113
112
114
113
| Parameter | Type | Required | Description |
115
114
| --------- | ---- | -------- | ----------- |
116
-
|`apiKey`| string | Yes | Harmonic team API key, sent in the apikey header |
117
115
|`savedSearchId`| string | Yes | People saved-search ID or full Harmonic saved-search URN |
118
116
|`size`| number | No | Results to return, 1-100 \(default 50\)|
119
117
|`cursor`| string | No | Opaque next-page cursor from a previous response |
@@ -158,7 +156,6 @@ Fetch full Harmonic person profiles for up to 500 combined numeric IDs and perso
158
156
159
157
| Parameter | Type | Required | Description |
160
158
| --------- | ---- | -------- | ----------- |
161
-
|`apiKey`| string | Yes | Harmonic team API key, sent in the apikey header |
162
159
|`personIds`| json | No | Array of numeric Harmonic person IDs; may be a JSON-array string |
163
160
|`personUrns`| json | No | Array of Harmonic person URNs; may be a JSON-array string |
0 commit comments