OnOffice

Overview

This node integrates with the OnOffice API to manage various resources such as estates, addresses, agent logs, relations, tasks, and IDs from relations. Specifically for the Relation resource with the Update operation, it updates an existing relation record identified by its ID.

Common scenarios where this node is useful include automating updates to contact or client information stored in OnOffice, synchronizing CRM data, or programmatically modifying relation details based on external triggers or workflows.

For example, you might use this node to update a client's contact information after receiving new data from a form submission or to change the status of a relation record as part of a sales pipeline automation.

Properties

Output

The node outputs JSON data structured as follows:

• On success (without debug info):

  {
    "success": true,
    "resourceType": "relation",
    "operation": "update",
    "data": []
  }
  

  • success: Indicates the operation was successful.
  • resourceType: The resource type operated on ("relation").
  • operation: The operation performed ("update").
  • data: An array intended to hold returned data; empty here since the API response does not return updated data directly.

• On success (with debug info enabled):

  {
    "debug": true,
    "rawResponse": { /* full raw API response object */ },
    "requestSent": { /* full request payload sent to API */ },
    "url": "https://api.onoffice.de/api/latest/api.php"
  }
  

  This includes the raw API response, the exact request sent, and the URL used, which helps in debugging.

• On failure (if continueOnFail is enabled):

  {
    "success": false,
    "error": "Error message describing what went wrong",
    "resourceType": "relation",
    "operation": "update"
  }
  

The node does not output binary data.

Dependencies

• Requires an API key credential for authenticating with the OnOffice API, including an API token and secret.
• Uses the OnOffice API endpoint:
  https://api.onoffice.de/api/latest/api.php (for most resources including Relation).
• The node internally generates HMAC signatures for request authentication.
• No additional external dependencies beyond the OnOffice API and n8n's HTTP request helper.

Troubleshooting

• Common issues:

  • Invalid or missing API credentials will cause authentication failures.
  • Providing an incorrect or non-existent ID for the relation record will result in API errors.
  • Network connectivity problems can prevent reaching the OnOffice API endpoint.
  • If the API returns an error status code, the node throws an error with the message from the API.

• Error messages:

  • "OnOffice API error: <message>" indicates the API responded with an error. Check the message for details (e.g., invalid ID, permission denied).
  • "Unknown error" may indicate unexpected API response format or network issues.

• How to resolve:

  • Verify that the API token and secret are correctly configured in the node credentials.
  • Ensure the ID provided corresponds to an existing relation record.
  • Enable "Include Debug Info" to get detailed request and response data for diagnosing issues.
  • Use n8n's "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

• OnOffice API Documentation (official API docs)
• n8n documentation on HTTP Request Node (for understanding underlying HTTP calls)
• n8n community forums and support channels for troubleshooting custom nodes and API integrations