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 allows users to update existing estate records by specifying the record ID and the new data in JSON format.

Common scenarios where this node is beneficial include:

  • Synchronizing updated property details from an external system into OnOffice.
  • Automating updates to estate listings based on changes in other databases or workflows.
  • Bulk updating multiple estate records programmatically within n8n workflows.

For example, a user might update the price or description of a property by providing the estate's unique ID and a JSON object containing the fields to change.

Properties

Name Meaning
ID The unique identifier of the estate record to update. This is required to specify which estate to modify.
Data A JSON object containing the fields and values to update on the estate record. Must be valid JSON representing the new data.

Output

The node outputs a JSON object with the following structure:

  • success: Boolean indicating if the update was successful (true).
  • resourceType: The resource affected, here always "estate".
  • operation: The operation performed, here "update".
  • data: Contains the updated estate data returned from the API.
  • message: A status message from the API confirming the update.

If the update fails, the output will contain:

  • success: false
  • error: Error message describing what went wrong.
  • resourceType and operation as above.

The output is wrapped in an array suitable for further processing in n8n workflows.

Dependencies

  • Requires an active connection to the OnOffice API using an API token and secret (configured via credentials in n8n).
  • The node uses HMAC signature authentication for API requests.
  • No additional external dependencies beyond the OnOffice API and n8n environment.

Troubleshooting

  • Invalid JSON in Data: If the "Data" property contains invalid JSON, the node throws an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • Missing or Incorrect ID: The "ID" field is required. Omitting it or providing an incorrect ID will cause the API call to fail.
  • API Errors: Errors returned by the OnOffice API are surfaced with messages like "OnOffice API error: ". Check the API token validity, permissions, and that the estate ID exists.
  • Network Issues: Network errors result in messages like "Network error:
    ". Verify network connectivity and API endpoint accessibility.
  • Unsupported Operation or Resource: If the node configuration specifies unsupported operations or resources, it throws descriptive errors.

To resolve issues:

  • Validate all input parameters carefully.
  • Confirm API credentials are correctly set up.
  • Review API documentation for allowed fields and formats.
  • Use the node’s "Continue On Fail" option to handle errors gracefully in bulk operations.

Links and References

Discussion