sevDesk icon

sevDesk

Consume the sevDesk API

Overview

This node integrates with the sevDesk API to perform operations on various resources, including "Contact Custom Field Setting". Specifically, the "Get" operation for the "Contact Custom Field Setting" resource retrieves details of a particular custom field setting associated with a contact in sevDesk.

Common scenarios where this node is beneficial include:

  • Fetching configuration details of custom fields set up for contacts to dynamically adjust workflows.
  • Retrieving metadata about contact custom fields for reporting or synchronization purposes.
  • Automating data retrieval processes that depend on specific custom field settings in sevDesk.

For example, you might use this node to get the settings of a custom field by its ID to display or process it further in your automation workflow.

Properties

Name Meaning
Contact Custom Field Setting ID The unique identifier (string) of the contact custom field setting to retrieve. This property is required for the "get" operation on the "Contact Custom Field Setting" resource.

Output

The node outputs an array of JSON objects corresponding to the retrieved data from the sevDesk API. For the "Get" operation on "Contact Custom Field Setting", each output item contains the detailed information of the specified custom field setting in JSON format.

If an error occurs and the node is configured to continue on failure, the output will include an object with an error field describing the issue.

The node does not output binary data.

Dependencies

  • Requires an active connection to the sevDesk API via an API key credential.
  • The base URL for API requests is https://my.sevdesk.de/api/ appended with the API version specified in credentials.
  • The node depends on internal resource management and validation modules to handle API requests and response validation.

Troubleshooting

  • Missing or invalid Contact Custom Field Setting ID: Ensure the ID provided is correct and exists in sevDesk; otherwise, the API will return an error.
  • API authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Network or connectivity issues: Check internet access and sevDesk service status.
  • Validation schema initialization failure: If the node logs an error about failing to initialize validation schemas, ensure all dependencies are properly installed and compatible.
  • Error messages in output: When "Continue On Fail" is enabled, errors are returned as JSON with an error message. Review these messages to identify issues such as invalid parameters or API limits.

Links and References

Discussion