OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses, and relations. For the Address resource with the Update operation, it updates an existing address record in the OnOffice system by sending the specified data fields.

Common scenarios where this node is useful include:

  • Synchronizing address information from other systems into OnOffice.
  • Automating updates to contact or location details of properties.
  • Bulk updating multiple address records programmatically.

For example, you might use this node to update the phone number or email of a contact address associated with a property after receiving new information from a CRM system.

Properties

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

Output

The node outputs a JSON array where each item corresponds to an input item processed. For the update operation on Address, the output JSON structure includes:

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

Example output JSON snippet:

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

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the OnOffice API.
  • Needs an API token and secret for authentication (configured as credentials in n8n).
  • Uses HMAC signature generation for request authentication.
  • The base URL for API requests is https://api.onoffice.de/api/v1.

Troubleshooting

  • Invalid JSON in Data field: If the Data property contains invalid JSON, the node throws an error: "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • Invalid ID: Providing an incorrect or non-existent address ID will cause the API to return an error. Verify the ID before running the update.
  • API errors: Errors returned from the OnOffice API are surfaced with messages like "OnOffice API error: ". Check the API documentation or your API credentials.
  • Network issues: Network connectivity problems result in errors like "Network error: ". Confirm network access and API endpoint availability.
  • Filter parsing errors: Although not relevant for update, other operations that accept filters require valid JSON; otherwise, a similar JSON parse error occurs.

If the node is set to continue on fail, failed items will output JSON with success: false and an error message describing the failure.

Links and References

Discussion