HeyReach

HeyReach

This connector uses the HeyReach public API (https://api.heyreach.io/api/public) for LinkedIn outreach: campaigns and their leads, lead and company lists, the unified LinkedIn inbox, sender accounts, lead tags, network checks, statistics and webhooks.

Setup

1. In HeyReach open Integrations and the HeyReach API section.
2. Click Get API Key, then New API Key, and copy the key into HEYREACH_API_KEY. Keys do not expire but can be deleted or deactivated there. A key belongs to one workspace.

The key is sent in the X-API-KEY header. heyreach_check_api_key returns 200 (empty body) when it works.

Ids

• campaign_id from heyreach_list_campaigns; sender ids (account_id, linkedin_account_id, sender_id) from heyreach_list_linkedin_accounts; list_id from heyreach_list_lists; conversation_id from heyreach_list_conversations; webhook_id from heyreach_list_webhooks.
• A lead is identified by its LinkedIn profile URL (https://www.linkedin.com/in/<slug>/) or its LinkedIn id (linkedin_id in lead records).

Campaigns

• Read: heyreach_list_campaigns (filter by status or sender), heyreach_get_campaign, heyreach_get_campaign_sequence, heyreach_list_campaign_leads, heyreach_get_campaigns_for_lead.
• Control: heyreach_start_campaign (draft to running), heyreach_pause_campaign, heyreach_resume_campaign.
• Leads: heyreach_add_leads_to_campaign (up to 100 per call, optional sender per lead), heyreach_stop_lead_in_campaign, heyreach_update_lead_custom_fields.
• Campaign statuses: DRAFT, IN_PROGRESS, PAUSED, FINISHED, CANCELED, FAILED, STARTING, SCHEDULED. Lead statuses: Pending, InSequence, Finished, Paused, Failed, Excluded.

Lists: heyreach_list_lists, heyreach_get_list, heyreach_list_list_leads (up to 1000 per page), heyreach_list_list_companies, heyreach_get_lists_for_lead, heyreach_create_list, heyreach_add_leads_to_list, heyreach_delete_leads_from_list. Adding leads to a list does not start them in a finished campaign; use heyreach_add_leads_to_campaign for that.

Leads and tags: heyreach_get_lead (profile details by URL), heyreach_get_lead_tags, heyreach_add_lead_tags, heyreach_replace_lead_tags.

Inbox

• heyreach_list_conversations lists conversations (cursor paging: pass nextCursor back as cursor until it is null). It does not return email addresses or custom fields; use heyreach_get_lead for those.
• heyreach_get_conversation returns the messages; heyreach_send_message replies from the sender that owns the conversation; heyreach_set_conversation_seen marks it read or unread.

Senders and network: heyreach_list_linkedin_accounts, heyreach_get_linkedin_account, heyreach_get_linkedin_account_status (is the LinkedIn session still valid), heyreach_list_network (1st-degree connections), heyreach_is_connection.

Statistics: heyreach_get_overall_stats and heyreach_get_stats_by_campaign take start_date and end_date (ISO 8601) and optional sender and campaign ids. byDayStats is keyed by day (UTC); rates are fractions (0.23 = 23%).

Webhooks: heyreach_list_webhooks, heyreach_get_webhook, heyreach_create_webhook, heyreach_update_webhook, heyreach_delete_webhook. One event type per webhook: CONNECTION_REQUEST_SENT, CONNECTION_REQUEST_ACCEPTED, MESSAGE_SENT, MESSAGE_REPLY_RECEIVED, EVERY_MESSAGE_REPLY_RECEIVED, INMAIL_SENT, INMAIL_REPLY_RECEIVED, FOLLOW_SENT, LIKED_POST, VIEWED_PROFILE, CAMPAIGN_COMPLETED, LEAD_TAG_UPDATED.

Paging: most lists take offset and limit (at most 100) and return totalCount and items. Times are ISO 8601, in UTC unless an offset is given.

Limits and errors: 300 requests per minute per key (429 above that). 401 means a wrong or deactivated key; 404 a wrong id; 400 an invalid body, for example a custom field name with characters other than letters, digits and underscores.

Creating campaigns, connecting LinkedIn accounts (passwords, cookies, proxies) and organization management are left out on purpose; do those in the HeyReach app.

Switched off at install: heyreach_delete_leads_from_list and heyreach_delete_webhook; they cannot be undone, so an admin switches them on when the team needs them.