OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data. Specifically, for the Estate resource and the Update operation, it updates an existing estate record by sending new data to the OnOffice system.

Common scenarios where this node is useful include:

  • Automating updates to property listings in a real estate management workflow.
  • Synchronizing changes made in other systems or forms back to the OnOffice platform.
  • Bulk updating multiple estates programmatically based on external triggers or schedules.

For example, if you have a CRM that tracks property details and you want to push updates to OnOffice whenever a property’s information changes, this node can be used to send those updates seamlessly.

Properties

Name Meaning
ID The unique identifier of the estate record to update. This tells the node which estate to modify.
Data A JSON object containing the fields and values to update on the estate record. This should be valid JSON representing the new data for the estate.

Output

The node outputs a JSON object with the following structure:

  • success: Boolean indicating whether the update was successful.
  • resourceType: The resource type involved, here always "estate".
  • operation: The operation performed, here always "update".
  • data: Contains the updated estate data returned from the API.
  • message: A status message from the API about the update operation.

Example output JSON:

{
  "success": true,
  "resourceType": "estate",
  "operation": "update",
  "data": { /* updated estate record data */ },
  "message": "Record updated successfully"
}

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 uses HMAC signature authentication for API requests.
  • Network access to https://api.onoffice.de/api/v1 must be available.

Troubleshooting

  • Invalid JSON in Data property: If the Data field contains malformed JSON, the node will throw an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct before running.
  • Invalid or missing ID: The ID property is required. Omitting it or providing an incorrect ID will cause the API call to fail.
  • API errors: If the OnOffice API returns an error, the node surfaces the message, e.g., "OnOffice API error: ". Check the API credentials and the validity of the data sent.
  • Network issues: Errors like "Network error" indicate connectivity problems. Verify network access and proxy settings if applicable.
  • Filter parsing errors: Although not directly relevant to update, other operations use filters that must be valid JSON; invalid filters cause errors.

If the node is set to continue on failure, it will output an error object instead of stopping execution.

Links and References

Discussion