AvantGuard - WebhookSite icon

AvantGuard - WebhookSite

AvantGuard - WebhookSite

Actions100

Overview

The "Get Matchers" operation in the "Matchers" resource retrieves a list of matchers associated with a specific integration. This node is useful when you want to fetch matching records or entities that have been linked or identified within an integration system. For example, it can be used to obtain matched company records from a CRM integration or to filter matched data based on various criteria such as whether they are already matched, pagination, or specific identifiers.

Typical use cases include:

  • Synchronizing matched records between systems.
  • Auditing or reporting on matched entities.
  • Filtering matched data for further processing or analysis.

Properties

Name Meaning
Integration Id The ID of the integration, found in the URL when editing an integration. Required to specify which integration's matchers to retrieve.
Additional Query Parameters Optional filters and pagination controls:
• Matched: Filter by whether the company has already been matched (boolean).
• Sync Id: Filter by the record ID in the integration (number).
• Identifier: Filter by the identifier in the integration (string).
• Page: The current page number of results (number).
• Page Size: Number of results per page (number).
• Company Id: Filter by company ID (number).

Output

The output JSON contains the retrieved matcher records according to the specified integration and optional filters. Each item in the output represents a matcher entity with its associated data fields as returned by the API.

If binary data were involved, it would typically represent files or attachments related to matchers, but this node focuses on JSON data retrieval only.

Dependencies

  • Requires an API key or authentication token configured in n8n credentials to access the integration service.
  • The base URL for the API must be set in the node credentials.
  • The node depends on the external integration platform's API to fetch matcher data.

Troubleshooting

  • Missing or invalid Integration Id: Ensure the integration ID is correctly provided and corresponds to an existing integration.
  • Authentication errors: Verify that the API key or authentication token is valid and has sufficient permissions.
  • Pagination issues: If no results appear, check the page and page size parameters; requesting pages beyond available data will return empty results.
  • Filter mismatches: Using incompatible or incorrect filter values (e.g., string instead of number) may cause no data to be returned.
  • API connectivity problems: Network issues or incorrect base URL configuration can prevent successful API calls.

Links and References

  • Refer to the integration platform’s official API documentation for detailed information on matcher endpoints and query parameters.
  • n8n documentation on how to configure API credentials and use HTTP request nodes for custom integrations.

Discussion