OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage relations between estates and addresses (contacts). Specifically, the "Create Relation" operation allows users to establish a new relationship linking an estate with an address, defining the type of relation such as owner, tenant, interested party, or contact.

Common scenarios include:

  • Associating a property (estate) with its owner or tenant.
  • Linking contacts who are interested parties in a real estate listing.
  • Managing various types of relationships between properties and people within a real estate CRM workflow.

Practical example:

  • Automatically create a "tenant" relation when a new rental agreement is signed, linking the tenant's contact information to the specific estate record.

Properties

Name Meaning
Relation Type Type of relation between estate and address. Options: Owner, Tenant, Interested Party, Contact
Estate ID The unique identifier of the estate to which the relation applies (required)
Address ID The unique identifier of the address/contact involved in the relation (required)

Output

The node outputs JSON data containing the result of the create operation. The structure includes:

  • success: Boolean indicating if the operation was successful.
  • resourceType: The resource affected, here always "relation".
  • operation: The performed operation, here "create".
  • data: The response data from the API about the created relation.
  • message: A status message returned by the API.

Example output JSON:

{
  "success": true,
  "resourceType": "relation",
  "operation": "create",
  "data": {
    // Relation details returned by the API
  },
  "message": "Relation created successfully"
}

The node does not output binary data.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • Needs configuration of these credentials in n8n before use.
  • Uses HMAC signature generation for request authentication.
  • Connects to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.

Troubleshooting

  • Invalid JSON in input fields: When providing JSON data (e.g., filters or data fields), ensure it is valid JSON; otherwise, the node throws an error.
  • API errors: If the API returns an error, the node surfaces the message. Common causes include invalid IDs, missing required fields, or authentication issues.
  • Network errors: Connectivity problems will cause network error messages.
  • Unsupported operations or resources: Attempting unsupported combinations will throw descriptive errors.
  • To handle failures gracefully, enable "Continue on Fail" in the node settings.

Links and References

Discussion