OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses, and relations. It supports operations such as creating, retrieving, updating, and deleting records for these resources.

For the Address resource with the Create operation, the node allows users to create a new address record in the OnOffice system by providing the address data in JSON format. This is useful in scenarios where you want to automate adding new contact addresses into your real estate management workflow, for example, when onboarding new clients or contacts.

Practical examples:

  • Automatically add a new client’s address when they fill out a form on your website.
  • Sync address data from another CRM or database into OnOffice.
  • Create addresses programmatically as part of a larger automation involving estates and relations.

Properties

Name Meaning
Data JSON object containing the details of the address to create. The structure should match the expected schema of the OnOffice API for an address record.

Output

The output is a JSON object that indicates the success of the operation and contains the created address data returned by the OnOffice API. The structure includes:

  • success: Boolean indicating if the creation was successful.
  • resourceType: The resource type, here always "address".
  • operation: The operation performed, here "create".
  • data: The newly created address record(s) as returned by the API.
  • message: A status message from the API confirming the creation.

Example output JSON structure:

{
  "success": true,
  "resourceType": "address",
  "operation": "create",
  "data": {
    /* Address record fields as returned by OnOffice */
  },
  "message": "Record created successfully"
}

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the OnOffice API using valid API credentials (an API token and secret).
  • The node uses HMAC signature authentication for secure API requests.
  • No additional external services are required beyond the OnOffice API.
  • The user must configure the OnOffice API credentials within n8n before using this node.

Troubleshooting

  • Invalid JSON in Data property: If the JSON provided in the "Data" field is malformed, the node will throw an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • API Authentication errors: If the API token or secret is invalid or missing, the node will fail to authenticate. Verify that the API credentials are correctly set up in n8n.
  • OnOffice API errors: Errors returned by the OnOffice API will be surfaced with messages like "OnOffice API error: ". Check the message for details, which may indicate issues such as invalid fields or permissions.
  • Network errors: Connectivity issues will result in "Network error" messages. Confirm network access to the OnOffice API endpoint.
  • Unsupported resource or operation: If the node configuration specifies an unsupported resource or operation, it will throw an error indicating this. Make sure to select valid combinations.

If "Continue On Fail" is enabled, the node will output error information per item instead of stopping execution.

Links and References

Discussion