OnOffice

Consume OnOffice API
Join our community

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.

Typical use cases include:

  • Modifying details of a property listing such as title, description, or other metadata.
  • Automating updates to estate records based on external triggers or workflows.
  • Synchronizing estate information from other systems into OnOffice.

For example, you might update an estate's price or status after receiving new information from a CRM or property management system.

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 in the estate record. This must be valid JSON representing the changes to apply.

Output

The node outputs a JSON array where each item corresponds to one input item processed. For the Update operation on Estate, the output JSON structure includes:

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

Example output JSON snippet:

{
  "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 API token and secret credential for authenticating with the OnOffice API.
  • The node uses HMAC signature generation for request authentication.
  • Network access to https://api.onoffice.de/api/latest/api.php is necessary.
  • Proper configuration of the API credentials within n8n is mandatory.

Troubleshooting

  • Invalid JSON in Data field: If the JSON provided in the Data property is malformed, the node throws an error: "Data must be a valid JSON". Ensure the JSON syntax is correct before running.
  • 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 connectivity problems result in errors like "Network error: ". Verify internet connection and API endpoint accessibility.
  • Unsupported operations or resources: If the node is misconfigured with unsupported resource-operation combinations, it will throw errors indicating the unsupported action.
  • Filter parsing errors: Although not relevant for update, other operations using filters require valid JSON; invalid filters cause errors.

To resolve these issues:

  • Validate all JSON inputs carefully.
  • Confirm API credentials and permissions.
  • Check that the estate ID exists in OnOffice.
  • Review network connectivity and firewall settings.

Links and References

Discussion