Heyreach

heyreach

HeyReach is a multichannel outreach platform designed to help businesses and professionals engage with their audience effectively.

Marketing Automation CRM Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (16)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Check API KeyHEYREACH_CHECK_API_KEYAcción

Tool to check if the api key is valid. use before making other api calls to confirm authentication.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Empty ListHEYREACH_CREATE_EMPTY_LISTAcción

Tool to create an empty list. use after deciding on list name and type.

Parámetros de entrada

namestringObligatorio
The name of the list to create.
typestringenum
The type of list to create. 'USER_LIST' for leads, 'COMPANY_LIST' for companies. Defaults to 'USER_LIST'.
COMPANY_LISTUSER_LIST

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create WebhookHEYREACH_CREATE_WEBHOOKAcción

Tool to create a new webhook. use when you need programmatic callbacks for heyreach events after confirming a valid api key.

Parámetros de entrada

eventTypestringObligatorioenum
Type of event that triggers the webhook.
CONNECTION_REQUEST_SENTCONNECTION_REQUEST_ACCEPTEDMESSAGE_SENTMESSAGE_REPLY_RECEIVEDINMAIL_SENTINMAIL_REPLY_RECEIVEDFOLLOW_SENTLIKED_POSTVIEWED_PROFILECAMPAIGN_COMPLETEDLEAD_TAG_UPDATED
webhookUrlstringObligatorio
Destination URL where HeyReach will send POST event payloads.
campaignIdsinteger[]
List of campaign IDs to filter events. If empty, listens for the eventType across all campaigns.
webhookNamestringObligatorio
Descriptive name for the webhook, used for identification.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete WebhookHEYREACH_DELETE_WEBHOOKAcción

Tool to delete an existing webhook. use when you need to remove callbacks for outdated or unwanted webhooks.

Parámetros de entrada

webhookIdstringObligatorio
Unique identifier of the webhook to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All CampaignsHEYREACH_GET_ALL_CAMPAIGNSAcción

Tool to retrieve all campaigns. use when you need a paginated list of campaigns for management or reporting.

Parámetros de entrada

limitinteger
Maximum number of campaigns to return (1-100)
offsetinteger
Number of campaigns to skip
keywordstring
Keyword to filter campaigns by name
statusesstring[]
Filter campaigns by statuses, e.g., ['DRAFT','PAUSED']
accountIdsinteger[]
Filter campaigns by LinkedIn account IDs

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All LeadsHEYREACH_GET_ALL_LEADSAcción

Tool to retrieve all leads in a heyreach list. use when you need paginated collection of leads after confirming a valid api key.

Parámetros de entrada

limitinteger
The maximum number of records to return, between 1 and 1000.
listIdintegerObligatorio
The ID of the lead list.
offsetinteger
The number of records to skip for pagination.
keywordstring
Search term to filter leads by name or other relevant fields.
createdTostring
ISO 8601 end date for filtering leads by creation time.
createdFromstring
ISO 8601 start date for filtering leads by creation time.
leadLinkedInIdstring
LinkedIn ID to filter leads.
leadProfileUrlstring
LinkedIn profile URL to filter leads.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All LinkedIn AccountsHEYREACH_GET_ALL_LINKEDIN_ACCOUNTSAcción

Tool to retrieve all linkedin accounts. use when you need a paginated list of linkedin accounts after confirming a valid api key.

Parámetros de entrada

limitinteger
Maximum number of accounts to return (1-100)
offsetinteger
Number of accounts to skip
keywordstring
Keyword to filter accounts by name

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All ListsHEYREACH_GET_ALL_LISTSAcción

Tool to retrieve all lists. use when you need a paginated list of lists after confirming a valid api key.

Parámetros de entrada

limitinteger
Maximum number of lists to return.
offsetinteger
Number of lists to skip for pagination.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All WebhooksHEYREACH_GET_ALL_WEBHOOKSAcción

Tool to retrieve all webhooks. use when you need a paginated collection of webhooks after confirming a valid api key.

Parámetros de entrada

limitinteger
Maximum number of webhooks to return
offsetinteger
Number of webhooks to skip for pagination

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Companies From ListHEYREACH_GET_COMPANIES_FROM_LISTAcción

Tool to get companies from a company list. use when you need a paginated list of companies after specifying a list id.

Parámetros de entrada

limitinteger
Maximum number of companies to return.
listIdintegerObligatorio
The ID of the company list to retrieve companies from.
offsetinteger
Number of companies to skip for pagination.
keywordstring
Keyword to filter companies by name or description.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Conversations V2HEYREACH_GET_CONVERSATIONS_V2Acción

Tool to retrieve paginated linkedin conversations with advanced filters. use when you need to fetch inbox conversations filtered by lead or profile details.

Parámetros de entrada

limitinteger
Maximum number of items to return (1-100)
offsetinteger
Number of items to skip for pagination
filtersobjectObligatorio
Filtering criteria for the conversations

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get LeadHEYREACH_GET_LEADAcción

Tool to retrieve detailed information for a lead by profile url. use after obtaining the exact linkedin profile url to fetch full lead details.

Parámetros de entrada

profileUrlstringObligatorio
The LinkedIn profile URL of the lead.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Leads From ListHEYREACH_GET_LEADS_FROM_LISTAcción

Tool to get a paginated list of leads from a lead list. use when you need to filter and page through leads for a specific list.

Parámetros de entrada

limitinteger
Maximum number of leads to return. Defaults to 10, max 1000.
listIdintegerObligatorio
The ID of the lead list to retrieve leads from.
offsetinteger
Number of leads to skip for pagination.
keywordstring
A search term to filter leads by name or other relevant fields.
createdTostring
ISO 8601 timestamp. Only include leads created on or before this date.
createdFromstring
ISO 8601 timestamp. Only include leads created on or after this date.
leadLinkedInIdstring
LinkedIn ID of the lead to filter by.
leadProfileUrlstring
LinkedIn profile URL to filter by, e.g., 'https://www.linkedin.com/in/john-doe/'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get My Network for SenderHEYREACH_GET_MY_NETWORK_FOR_SENDERAcción

Tool to get the linkedin network for a specified sender account. use when you need to retrieve paginated connections for a sender.

Parámetros de entrada

pageSizeintegerObligatorio
Number of items per page (must be positive)
senderIdintegerObligatorio
ID of the LinkedIn sender account for which to retrieve the network
pageNumberintegerObligatorio
Zero-based index of the page to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Webhook By IDHEYREACH_GET_WEBHOOK_BY_IDAcción

Tool to retrieve a webhook by its id. use when you need detailed configuration of a specific webhook after listing or creating it.

Parámetros de entrada

webhookIdintegerObligatorio
The unique identifier of the webhook to retrieve (positive integer)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update WebhookHEYREACH_UPDATE_WEBHOOKAcción

Tool to update an existing webhook’s configuration. use when you need to modify a webhook's name, url, event type, campaigns, or activation status after confirming the webhookid.

Parámetros de entrada

isActiveboolean
Activation status of the webhook. True to enable, False to disable, if omitted or null, the existing status is retained.
eventTypestringenum
New event type to trigger the webhook. If omitted or null, the existing eventType is retained.
CONNECTION_REQUEST_SENTCONNECTION_REQUEST_ACCEPTEDMESSAGE_SENTMESSAGE_REPLY_RECEIVEDINMAIL_SENTINMAIL_REPLY_RECEIVEDFOLLOW_SENTLIKED_POSTVIEWED_PROFILECAMPAIGN_COMPLETEDLEAD_TAG_UPDATED
webhookIdstringObligatorio
Unique identifier of the existing webhook to update.
webhookUrlanyuri
New destination URL where HeyReach will send POST event payloads. If omitted or null, the existing URL is retained.
campaignIdsinteger[]
List of campaign IDs to scope the webhook. If omitted or null, retains existing campaigns; if empty list, listens for the eventType across all campaigns.
webhookNamestring
New name for the webhook. If omitted or null, the existing name is retained.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not