OnOffice icon

OnOffice

Consume OnOffice API

Actions30

Overview

This node integrates with the OnOffice API to perform various operations on different resources such as estates, addresses, relations, tasks, and others. Specifically, for the Address resource with the Create operation, it allows users to create a new address record in the OnOffice system.

Common scenarios where this node is beneficial include:

  • Automating the creation of new address entries when onboarding new properties or contacts.
  • Integrating address data from external sources into OnOffice without manual entry.
  • Streamlining workflows that require dynamic address creation based on other triggers or data inputs.

For example, a real estate agency could use this node to automatically add new property addresses received from a lead capture form directly into their OnOffice database.

Properties

Name Meaning
Include Debug Info Whether to include detailed debug information in the output (e.g., raw API response).

Output

The node outputs JSON data structured as follows:

  • If Include Debug Info is enabled:

    • debug: A boolean set to true.
    • rawResponse: The full raw response object returned by the OnOffice API.
    • requestSent: The exact request payload sent to the API.
    • url: The API endpoint URL used.

  • Otherwise:

    • success: Boolean indicating if the operation was successful (true).
    • resourceType: The resource acted upon, here "address".
    • operation: The operation performed, here "create".
    • data: An array containing the result data from the API (empty in the provided code but typically would contain created record details).

If an error occurs and the node is configured to continue on failure, the output JSON will include:

  • success: false
  • error: Error message string
  • resourceType and operation fields for context.

The node does not output binary data.

Dependencies

  • Requires an API token credential and API secret credential for authenticating with the OnOffice API.
  • Uses the OnOffice API endpoints:
    • Stable API: https://api.onoffice.de/api/stable/api.php (used only for relation-getMany)
    • Latest API: https://api.onoffice.de/api/latest/api.php (used for all other requests including Address Create)
  • The node internally generates HMAC signatures for request authentication using the provided credentials.
  • 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.
    • Incorrect resource or operation parameters may lead to API errors.
    • Network connectivity problems can prevent reaching the OnOffice API endpoint.

  • Error messages:

    • "OnOffice API error: <message>" indicates the API responded with an error status. Check the message for details.
    • Unknown errors may occur if the API response is malformed or unexpected.

  • Resolutions:

    • Verify that the API token and secret are correctly configured in n8n credentials.
    • Ensure the resource and operation parameters match supported values.
    • Enable "Include Debug Info" to get detailed request and response data for troubleshooting.
    • Check network access and firewall settings to allow outbound HTTPS requests to OnOffice API.

Links and References

Discussion