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:

  • Synchronizing updated property details from another system into OnOffice.
  • Automating bulk updates of estate information based on external triggers or workflows.
  • Correcting or enhancing estate records programmatically without manual entry.

For example, if a property's description or price changes in your CRM, you can use this node to update the corresponding estate record in OnOffice automatically.

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. 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 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 about the update operation.

Example output JSON:

{
  "success": true,
  "resourceType": "estate",
  "operation": "update",
  "data": {
    /* Updated estate record fields */
  },
  "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/latest/api.php is necessary.

Troubleshooting

  • Invalid JSON in Data: If the Data property contains malformed JSON, the node will throw an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct before running.
  • API Authentication Errors: If the API token or secret are incorrect or missing, the node will fail with an authentication error. Verify that the API credentials are properly configured.
  • Resource or Operation Not Supported: If the resource or operation parameters are incorrect or unsupported, the node throws an error indicating the unsupported resource or operation.
  • Network Issues: Network failures or timeouts will result in errors mentioning network problems. Check connectivity and API availability.
  • API Error Responses: If the OnOffice API returns an error, the node surfaces the API's error message. Review the message for details on what went wrong (e.g., invalid ID, permission issues).

Using the "Continue On Fail" option allows the workflow to proceed even if some items fail.

Links and References

Discussion