HeyReach API icon

HeyReach API

Interact with HeyReach API
Join our community

Actions33

Overview

The node integrates with the HeyReach API to manage webhooks. Specifically, the "Get Many" operation under the "Webhook" resource retrieves multiple webhook records from the HeyReach platform. This is useful for scenarios where you want to list all configured webhooks or paginate through them to analyze or manage webhook configurations programmatically.

Practical examples include:

  • Fetching a list of all active webhooks to display in a dashboard.
  • Paginating through webhook records to audit or synchronize webhook settings.
  • Integrating webhook data retrieval into automated workflows for monitoring or reporting purposes.

Properties

Name Meaning
Offset Number of records to skip for pagination. Defaults to 0. Used to control the starting point of the returned list.
Limit Maximum number of records to return. Must be at least 1 and no more than 100. Defaults to 10. Controls the page size of the results.

Output

The node outputs JSON data containing an array of webhook objects retrieved from the HeyReach API. Each object represents a webhook with its associated properties as defined by the HeyReach service. The output structure allows further processing or filtering within n8n workflows.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the HeyReach API.
  • The node uses the base URL https://api.heyreach.io/api/n8n for API requests.
  • Proper configuration of the HeyReach API credentials in n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Requesting a limit above 100 may result in errors or truncated responses.
    • Network connectivity problems can prevent access to the HeyReach API endpoint.

  • Error messages and resolutions:

    • Authentication failed: Verify that the API key credential is correctly set up and has sufficient permissions.
    • Invalid parameter 'limit': Ensure the limit value is between 1 and 100.
    • Timeout or network error: Check internet connection and firewall settings allowing outbound HTTPS requests to the HeyReach API.

Links and References

Discussion