OnOffice icon

OnOffice

Consume OnOffice API

Actions30

Overview

This node integrates with the OnOffice API to manage real estate-related data. Specifically, for the Estate resource and the Delete operation, it deletes a real estate record identified by its ID from the OnOffice system.

Common scenarios where this node is useful include:

  • Automating cleanup of outdated or incorrect estate records.
  • Integrating with workflows that synchronize property databases and need to remove entries.
  • Managing estate lifecycle by programmatically deleting records when they are no longer relevant.

Example use case: A real estate agency automates their CRM system to delete properties that have been sold or withdrawn from the market by triggering this node with the corresponding estate ID.

Properties

Name Meaning
ID The unique identifier of the estate record to delete. This is required to specify which record to remove.
Include Debug Info Boolean flag to include detailed debug information in the output, such as raw API responses and request details. Useful for troubleshooting.

Output

The node outputs JSON data structured as follows:

  • If Include Debug Info is enabled, the output includes:

    • debug: true
    • rawResponse: The full raw response from the OnOffice API.
    • requestSent: The exact request payload sent to the API.
    • url: The API endpoint URL used.

  • Otherwise, the output contains:

    • success: true (indicating the deletion was successful)
    • resourceType: "estate"
    • operation: "delete"
    • data: An empty array (no additional data returned on delete)

If an error occurs and the node is set to continue on failure, the output will contain:

  • success: false
  • error: Error message describing what went wrong
  • resourceType and operation fields for context

The node does not output binary data.

Dependencies

  • Requires valid credentials for the OnOffice API, specifically an API token and secret.
  • The node uses HMAC signature authentication to securely communicate with the OnOffice API.
  • Network access to https://api.onoffice.de/api/latest/api.php (or a legacy endpoint for some resources) is necessary.
  • No other 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 estate ID will result in an API error indicating the record cannot be found.
    • Network connectivity problems can prevent communication with the OnOffice API.
    • 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 such as invalid ID or permission issues.
    • Network or timeout errors will surface as standard HTTP request errors.

  • Resolution tips:

    • Verify API credentials are correct and have sufficient permissions.
    • Confirm the estate ID exists in the OnOffice system before attempting deletion.
    • 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

Discussion