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 email or phone number 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. This should be valid JSON representing the changes to apply.

Output

The node outputs a JSON object with the following structure:

  • 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:

{
  "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 API token and secret for authenticating with the OnOffice API.
  • Needs the OnOffice API credentials configured in n8n (an API key credential and secret).
  • Uses HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/v1.
  • Relies on helper functions to generate request IDs, create request bodies, and sign requests with HMAC.

Troubleshooting

  • Invalid JSON in Data field: If the Data property contains invalid JSON, the node will throw an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • Missing or incorrect ID: The ID property is required. Omitting it or providing an invalid ID will cause the API call to fail.
  • API authentication errors: If the API token or secret are missing or incorrect, the node will return an API error. Verify that the OnOffice API credentials are correctly set up in n8n.
  • Network issues: Network errors during the HTTP request will result in a "Network error" message. Check your internet connection and API availability.
  • API error messages: If the OnOffice API returns an error, the node surfaces the message from the API response. Review the message to understand the issue (e.g., permission denied, invalid parameters).

Links and References

Discussion