OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses, and relations. For the Address resource with the Create operation, it allows users to create new address records by sending structured JSON data representing the address details to the OnOffice system.

Common scenarios where this node is beneficial include:

  • Automating the addition of new contact addresses into a real estate management system.
  • Integrating external form submissions or CRM data into OnOffice by creating address entries automatically.
  • Streamlining workflows that require batch creation of addresses from other systems.

Example: A user collects contact information via a web form and uses this node to create corresponding address records in OnOffice without manual entry.

Properties

Name Meaning
Data JSON object containing the address details to create. This should be a valid JSON structure matching the expected format for an address in OnOffice.

Output

The node outputs a JSON array where each item corresponds to an input item processed. For the create operation on Address, the output JSON has the following structure:

{
  "success": true,
  "resourceType": "address",
  "operation": "create",
  "data": { /* The created address record(s) returned by OnOffice */ },
  "message": "..." /* Optional message from the API */
}
  • success: Indicates if the operation was successful.
  • resourceType: Always "address" for this resource.
  • operation: Always "create" for this operation.
  • data: Contains the newly created address record(s) as returned by the OnOffice API.
  • message: Optional status message from the API.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the OnOffice API using an API token and secret (configured as credentials in n8n).
  • The node sends HTTP POST requests to the OnOffice stable API endpoint (https://api.onoffice.de/api/stable/api.php).
  • Proper API credentials must be configured in n8n before use.

Troubleshooting

  • Invalid JSON in Data property: If the JSON provided in the "Data" field is malformed, the node throws an error indicating "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • API errors: Errors returned by the OnOffice API are surfaced with messages like OnOffice API error: <message>. Check the API token validity, permissions, and the correctness of the data payload.
  • Network issues: Network connectivity problems result in errors such as Network error: <message>. Verify network access and API endpoint availability.
  • Unsupported operations or resources: If the node configuration specifies unsupported combinations, it will throw errors indicating the resource or operation is not supported.
  • When processing multiple items, enabling "Continue On Fail" allows the node to continue processing subsequent items even if some fail.

Links and References

Discussion