sevDesk icon

sevDesk

Consume the sevDesk API

Overview

This node integrates with the sevDesk API to manage various resources, including custom field settings for contacts. Specifically, the "Create" operation under the "Contact Custom Field Setting" resource allows users to create new custom field settings associated with contacts in sevDesk. This is useful when you want to extend contact data with additional custom attributes tailored to your business needs.

Practical examples include:

  • Adding a new custom field setting named "Customer Type" to categorize contacts.
  • Creating a description for a custom field setting to clarify its purpose within your CRM.

Properties

Name Meaning
Additional Fields A collection of optional fields to specify details about the custom field setting:
- Name The name of the custom field setting (required).
- Description An optional description providing more context about the custom field setting.

Output

The node outputs an array of JSON objects representing the results of the create operation(s). Each object corresponds to a created custom field setting and contains the response data returned by the sevDesk API.

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

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The base URL for API requests is https://my.sevdesk.de/api/ combined with the API version specified in credentials.
  • Environment configuration validation is performed before execution.
  • Validation schemas are initialized at module load time to ensure request data integrity.

Troubleshooting

  • Common issues:

    • Missing or invalid API authentication token can cause authorization failures.
    • Providing an empty or missing "Name" field in additional fields will likely result in validation errors from the API.
    • Network connectivity problems may prevent successful API calls.
  • Error messages:

    • Errors thrown during the API call are caught; if "Continue On Fail" is enabled, they appear in the output as { json: { error: "message" } }.
    • Initialization failures of validation schemas are logged to the console but do not stop node execution.
  • Resolutions:

    • Ensure the API key credential is correctly configured and has necessary permissions.
    • Provide all required fields, especially the "Name" for the custom field setting.
    • Check network connectivity and sevDesk service status.

Links and References

Discussion