HeyReach API icon

HeyReach API

Interact with HeyReach API
Join our community

Actions33

Overview

The node integrates with the HeyReach API to update an existing webhook configuration. It allows users to modify properties of a webhook such as its name, event type that triggers it, associated campaign IDs, target URL, and activation status. This is useful in automation workflows where dynamic control over webhook behavior is needed, for example, changing the webhook URL after deployment or adjusting which events trigger notifications.

Practical examples:

  • Updating the webhook URL to point to a new endpoint after migrating services.
  • Changing the event type to listen for different user interactions like message replies or connection requests.
  • Activating or deactivating a webhook without deleting it.
  • Associating the webhook with specific campaigns to filter incoming data.

Properties

Name Meaning
Webhook ID Unique identifier of the webhook to update.
Webhook Name The name of the webhook. Must be between 3 and 25 characters.
Event Type The event type that triggers the webhook. Options: 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. Multiple numeric values allowed.
Webhook URL The URL to which the webhook will send POST requests. Must be a valid URL. Leave null to keep the existing URL.
Is Active Whether the webhook is active (true/false).

Output

The node outputs JSON data representing the updated webhook object returned by the HeyReach API. This typically includes the webhook's current configuration details such as its ID, name, event type, associated campaigns, URL, and active status.

If the node supports binary data output, it is not indicated in the provided code or properties, so the output is expected to be purely JSON.

Dependencies

  • Requires an API key credential for authenticating with the HeyReach API.
  • The base URL for API requests is https://api.heyreach.io/api/n8n.
  • The node expects the HeyReach API to be accessible and the provided webhook ID to exist.

Troubleshooting

  • Invalid Webhook ID: If the webhook ID does not exist or is incorrect, the API will likely return an error indicating the webhook was not found. Verify the ID before running the node.
  • Invalid URL Format: Providing an invalid webhook URL may cause the update to fail. Ensure the URL is properly formatted.
  • Permission Issues: Insufficient permissions or invalid API credentials can cause authentication errors. Confirm the API key is valid and has rights to update webhooks.
  • Empty Required Fields: The webhook ID is required; omitting it will prevent execution.
  • Event Type Mismatch: Selecting an unsupported event type or leaving it empty when required might cause errors.
  • API Rate Limits: Frequent updates may hit rate limits imposed by HeyReach API.

Links and References

Discussion