OnOffice icon

OnOffice

Consume OnOffice API

Actions15

Overview

This node integrates with the OnOffice API to manage real estate data and related resources. Specifically, for the Estate - Create operation, it allows users to create a new real estate entry by sending detailed property information to the OnOffice system.

Common scenarios where this node is beneficial include:

  • Real estate agencies automating the addition of new property listings from external systems or forms.
  • Synchronizing property databases by programmatically adding estates.
  • Integrations where new estate data needs to be pushed into OnOffice without manual entry.

Practical example: Automatically creating a new apartment listing in OnOffice when a user submits a form on a website, including details like title, type, price, location, and description.

Properties

Name Meaning
Data JSON object containing the estate details to create. This includes fields such as:
- objekttitel: Title of the property (e.g., "Moderne Wohnung im Zentrum")
- objektart: Property type (e.g., "wohnung" for apartment)
- vermarktungsart: Marketing type (e.g., "kauf" for sale)
- kaufpreis: Purchase price
- wohnflaeche: Living area in square meters
- anzahl_zimmer: Number of rooms
- plz: Postal code
- ort: City
- strasse: Street name
- hausnummer: House number
- objektbeschreibung: Description of the property

The Data property must be a valid JSON string representing the estate's attributes.

Output

The node outputs a JSON object with the following structure upon successful creation:

  • success: Boolean indicating if the operation was successful (true).
  • resourceType: The resource involved, here "estate".
  • operation: The operation performed, here "create".
  • data: An object containing the created estate's data as returned by the OnOffice API.
  • message: A status message from the API confirming the creation.

If the API request fails or returns an error, the output will contain error details including messages and raw response data for debugging.

No binary data output is produced by this operation.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • The node expects these credentials to be configured in n8n under a generic API authentication credential.
  • Network access to https://api.onoffice.de/api/latest/api.php is required.

Troubleshooting

  • Invalid JSON in Data property: If the Data input is not valid JSON, the node throws an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct before running.
  • API Request Failed: Network issues, invalid credentials, or API downtime can cause request failures. Check the API token and secret, network connectivity, and OnOffice service status.
  • API action errors: If the API returns an error code, the node surfaces the message from the API. Review the message for issues like missing required fields or invalid values.
  • Unsupported resource or operation: Using unsupported combinations will throw errors indicating the resource or operation is not supported.

To resolve errors, verify input data correctness, credentials validity, and API availability.

Links and References

Discussion