Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Overview

The node integrates with the Magnet Customer API to perform various operations on different resources, including tasks. Specifically, for the Task resource and the Search operation, it allows users to search for tasks based on a search string. This is useful in scenarios where you want to find specific tasks matching certain keywords or criteria within your Magnet Customer account.

Practical examples include:

  • Searching for tasks related to a particular project or client by keyword.
  • Filtering tasks to find those assigned to a specific staff member or containing certain terms.
  • Quickly retrieving task information to automate workflows such as notifications or updates.

Properties

Name Meaning
Authentication Method of authentication to use: either "API Token" or "OAuth2".
Search The search string to look for in tasks. Must be at least 3 characters long.
Page The page number of results to retrieve (pagination).
Limit Maximum number of results to return. Minimum value is 15.

Note: There are several hidden properties related to "Life Cycle" and "Source" which are preset internally and not exposed for user input in this operation.

Output

The output is a JSON array containing the search results for tasks matching the provided search string. Each item in the output corresponds to a task object returned by the Magnet Customer API. The structure includes all relevant task details as provided by the API.

If binary data were involved (not indicated here), it would typically represent attachments or files related to tasks, but this operation focuses on JSON data only.

Dependencies

  • Requires an active connection to the Magnet Customer API.
  • Supports two authentication methods: API Token or OAuth2.
  • The node depends on proper configuration of credentials in n8n for accessing the Magnet Customer API.
  • No additional environment variables are explicitly required beyond standard n8n credential setup.

Troubleshooting

  • Common issues:

    • Providing a search string shorter than 3 characters will likely cause the API to reject the request or return no results.
    • Pagination parameters (page and limit) must be valid numbers; invalid values may cause errors or unexpected behavior.
    • Authentication failures if API token or OAuth2 credentials are incorrect or expired.
  • Error messages:

    • Errors from the API will be caught and can be output as error messages in the node's output if "Continue On Fail" is enabled.
    • Common error messages might include authentication errors ("Unauthorized"), validation errors ("Search string too short"), or rate limiting responses.
  • Resolutions:

    • Ensure the search string meets minimum length requirements.
    • Verify that credentials are correctly configured and have sufficient permissions.
    • Adjust pagination parameters to valid ranges.
    • Enable "Continue On Fail" to handle errors gracefully during batch processing.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions.

Discussion