sevDesk icon

sevDesk

Consume the sevDesk API

Overview

This node integrates with the sevDesk API to create a new communication way for a contact. A communication way represents a method of contacting someone, such as an email address, phone number, website, or mobile number. This node is useful in scenarios where you want to programmatically add or update contact communication details within sevDesk, for example, when importing contacts from another system or updating contact information automatically.

Practical examples:

  • Adding a new email address as a primary contact method for a customer.
  • Registering a phone number or mobile number for a supplier.
  • Storing a website URL associated with a contact.

Properties

Name Meaning
Contact The contact to which this communication way belongs. Includes:
- Contact ID The unique identifier of the contact.
- Object Name Fixed string "Contact" indicating the object type.
Key The key of the communication way. Includes:
- Key ID The unique identifier of the communication way key.
- Object Name Fixed string "CommunicationWayKey" indicating the object type.
Communication Way Type The type of communication way. Options: Email, Phone, Web, Mobile.
Value The actual value of the communication way, e.g., the email address, phone number, or URL.
Main Boolean flag indicating whether this is the main communication way for the contact.

Output

The node outputs JSON data representing the result of the creation operation on the communication way resource. This typically includes the newly created communication way's details as 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 error message associated with the specific input item.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The base URL for API requests is https://my.sevdesk.de/api/ followed by the API version specified in credentials.
  • The node depends on internal resource management and validation modules bundled with the node implementation.

Troubleshooting

  • Common issues:

    • Missing or invalid API authentication token can cause authorization errors.
    • Providing incomplete or incorrect contact or key IDs may lead to resource not found errors.
    • Invalid values for communication way type or missing required fields will cause validation errors.
  • Error messages:

    • Errors returned from the API are captured and included in the output if "continue on fail" is enabled.
    • Validation schema initialization failures are logged to the console but do not stop node execution.
  • Resolution tips:

    • Ensure all required properties (contact, key, type, value) are correctly set.
    • Verify that the API key credential is valid and has necessary permissions.
    • Use correct IDs corresponding to existing contacts and keys in sevDesk.

Links and References

Discussion