OnOffice

Consume OnOffice API
Join our community

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 Create operation, it allows users to create a new address record in the OnOffice system by providing the necessary address data in JSON format.

Typical use cases include:

  • Automating the addition of new contact addresses into a real estate management system.
  • Integrating form submissions or CRM data flows to automatically create address entries.
  • Synchronizing external address data sources with OnOffice.

Example: A user can input a JSON object containing details like name, email, and phone number to create a new address contact in OnOffice.

Properties

Name Meaning
Data JSON object representing the address data to create. This should contain all relevant fields for the address record as expected by OnOffice (e.g., name, vorname, email).

Output

The node outputs a JSON array where each item corresponds to an input item processed. The output JSON structure includes:

  • success: Boolean indicating if the operation was successful.
  • resourceType: The resource involved, here always "address".
  • operation: The operation performed, here "create".
  • data: The response data from OnOffice about the created address record.
  • message: Optional message from the API status.

No binary data is output by this node.

Example output JSON snippet:

{
  "success": true,
  "resourceType": "address",
  "operation": "create",
  "data": {
    /* Created address record details */
  },
  "message": "Record created successfully"
}

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • The node makes HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of the API credentials in n8n is necessary 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 errors: Errors returned from the OnOffice API are surfaced with messages prefixed by "OnOffice API error:". Check the message for details such as invalid fields or authentication issues.
  • Network errors: If the node cannot reach the API endpoint, it throws a "Network error" with the underlying message. Verify network connectivity and API endpoint accessibility.
  • Unsupported operations or resources: If an unsupported resource or operation is selected, the node throws an error indicating the unsupported combination.
  • Filter parsing errors: When using filters in other operations, invalid JSON filters cause errors; ensure filter JSON is valid.

Links and References

Discussion