@superagnt/heyreach-outreach 2.0.2

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/README.md ADDED
@@ -0,0 +1,80 @@
1
+ # HeyReach integration for OpenClaw — superagnt plugin
2
+
3
+ Connect your HeyReach workspace to superagnt to automate LinkedIn outreach campaigns, lead lists, inbox replies, and analytics through a unified API. Manage LinkedIn campaigns, leads, lead lists, conversations, and analytics across your connected sender accounts through a single superagnt API key.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ openclaw plugins install @superagnt/heyreach-outreach
9
+ ```
10
+
11
+ This package is the official **OpenClaw** plugin for the **HeyReach** integration via [superagnt](https://superagnt.com). Pair it with the [documentation](https://superagnt.com) and your superagnt API key.
12
+
13
+ ## Live MCP mode (recommended)
14
+
15
+ Set a workspace MCP token and the plugin upgrades itself at load: it fetches
16
+ the live tool list from the scoped MCP endpoint and proxies calls through it —
17
+ the tool surface then grows with `agnt_tools_enable`, no plugin update needed.
18
+
19
+ ```bash
20
+ export SUPERAGNT_MCP_TOKEN=... # from the MCP server card in the dashboard
21
+ ```
22
+
23
+ Without the token the plugin uses its built-in toolset with your
24
+ `SUPERAGNT_API_KEY` — no behavior change from previous versions.
25
+
26
+ ## Overview
27
+
28
+ OpenClaw plugin for HeyReach LinkedIn outreach — manage campaigns, leads, lead lists, conversations, and analytics with your superagnt API key.
29
+
30
+ ### Highlights
31
+
32
+ - Campaigns — list, inspect, pause, and resume LinkedIn outreach campaigns
33
+ - Lead injection — add leads to active campaigns with per-lead sender account routing
34
+ - Lead lookup — fetch a stored lead by LinkedIn profile URL with campaign membership and last activity
35
+ - Lead & company lists — list and create empty lists used as campaign sources
36
+ - Unified inbox — query LinkedIn conversations with filters for campaign, sender, label, read state, and time window
37
+ - Analytics — aggregated outreach stats (sent, accepted, replied, view, like, follow) across campaigns and senders
38
+ - Network sync — paginate the 1st-degree LinkedIn connections of any connected sender account
39
+ - API key health — `/auth/CheckApiKey` for credential probes from your monitoring stack
40
+
41
+ ### Example use cases
42
+
43
+ - Push leads from your data warehouse or enrichment pipeline into running HeyReach campaigns
44
+ - Build AI agents that triage HeyReach replies and write them back to your CRM
45
+ - Sync the unified inbox into Slack or a CRM with per-campaign routing
46
+ - Pause or resume campaigns automatically based on inventory, deliverability, or budget signals
47
+ - Generate weekly outreach reports across senders and campaigns from `/stats/GetOverallStats`
48
+ - Mirror a sender's 1st-degree LinkedIn network into a CRM for retargeting workflows
49
+
50
+ ## Prerequisites
51
+
52
+ 1. An **superagnt API key** — create and manage keys in the [superagnt dashboard](https://app.superagnt.com/dashboard).
53
+ 2. A connected **HeyReach** account — configure in the [integrations dashboard](https://app.superagnt.com/dashboard/connections).
54
+
55
+ ## Authentication
56
+
57
+ Set `SUPERAGNT_API_KEY` in your environment, or complete browser login when the gateway prompts you.
58
+
59
+ ## API coverage
60
+
61
+ | | |
62
+ | --- | --- |
63
+ | **Integration** | `heyreach` |
64
+ | **REST base** | `https://api.superagnt.com/v1/connections/heyreach` |
65
+ | **OpenAPI operations** | 59 |
66
+ | **OpenClaw tools** | 59 |
67
+
68
+ ## Documentation
69
+
70
+ - [Documentation](https://superagnt.com) — getting started and concepts
71
+ - [Connection guide (HeyReach)](https://superagnt.com/connections/heyreach) — setup and endpoints
72
+ - [Dashboard](https://app.superagnt.com/dashboard) — API keys and usage
73
+
74
+ ## Related
75
+
76
+ - **Skill (curl-oriented):** `clawhub install heyreach-outreach` on [ClawHub](https://clawhub.ai/superagnt/skills/heyreach-outreach)
77
+
78
+ ## License
79
+
80
+ MIT