HeyReach API icon

HeyReach API

Interact with HeyReach API
Join our community

Actions33

Overview

The node integrates with the HeyReach API to create webhooks that listen for specific event types related to campaigns and messaging activities. When a specified event occurs (e.g., a connection request sent, message reply received, or campaign completed), the webhook triggers an HTTP POST request to a user-defined URL. This enables automation workflows to react in real-time to events happening within HeyReach campaigns or messaging.

Common scenarios include:

  • Automatically processing leads or messages when a new connection request is sent.
  • Tracking campaign progress by receiving notifications when campaigns complete.
  • Integrating with external systems by forwarding event data via webhooks.

Example: A marketing team could use this node to create a webhook that listens for "Message Reply Received" events and automatically logs replies into their CRM system.

Properties

Name Meaning
Webhook Name The name of the webhook. Must be between 3 and 25 characters.
Webhook URL The destination URL that will receive POST requests from the webhook. Must be a valid URL.
Event Type The event type that triggers the webhook. Options include:
- Connection Request Sent
- Connection Request Accepted
- Message Sent
- Message Reply Received
- InMail Sent
- InMail Reply Received
- Follow Sent
- Liked Post
- Viewed Profile
- Campaign Completed
- Lead Tag Updated
- Every Message/InMail Reply Received
Campaign IDs A list of campaign IDs to associate with the webhook. If empty, the webhook applies to all campaigns. Not available for "Lead Tag Updated" and "Every Message/InMail Reply Received" event types.

Output

The node outputs JSON data representing the created webhook object as returned by the HeyReach API. This typically includes details such as the webhook ID, name, associated event type, target URL, and linked campaign IDs.

If the webhook creation fails, the node will throw an error describing the issue.

No binary data output is involved.

Dependencies

  • Requires an active HeyReach API key credential configured in n8n.
  • The node makes HTTP requests to the HeyReach API endpoint at https://api.heyreach.io/api/n8n.
  • Proper network connectivity to HeyReach API and the webhook destination URL is necessary.

Troubleshooting

  • Invalid Webhook URL: Ensure the provided webhook URL is a valid and reachable HTTP(S) endpoint.
  • Webhook Name Length: The webhook name must be between 3 and 25 characters; otherwise, the API may reject the request.
  • Event Type Restrictions: Some event types do not support associating campaign IDs; attempting to set them may cause errors.
  • API Authentication Errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Network Issues: Check connectivity to both HeyReach API and the webhook URL to avoid timeouts or connection failures.

Links and References

Discussion