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 (single or multiple), updating, and deleting records for these resources.
For the Address - 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 from a web form submission.
- Sync address data from another CRM or database into OnOffice.
- Batch create multiple addresses via n8n workflows.
Properties
Name | Meaning |
---|---|
Data | JSON object containing the address details to create. The structure must conform to OnOffice API's expected address schema. Example fields might include name, first name, email, phone, street, city, postal code, etc. |
Output
The node outputs a JSON object with the following structure upon successful creation:
success
: Boolean indicating if the operation was successful (true
).resourceType
: The resource type, here"address"
.operation
: The operation performed, here"create"
.data
: The response data from the OnOffice API, typically including the created address record details.message
: A status message returned by the API confirming the creation.
If the API returns multiple records (not typical for create), they will be under data.records
. For create, usually data
contains the single created record.
In case of failure, the output includes:
success
:false
error
: Error message describing what went wrong.resourceType
andoperation
for context.
No binary data output is produced by this node.
Dependencies
- Requires an active connection to the OnOffice API using valid credentials that provide an API token and secret.
- The node uses HMAC signature authentication for requests.
- Network access to
https://api.onoffice.de/api/v1
is required. - No additional external dependencies beyond the OnOffice API and n8n environment.
Troubleshooting
- Invalid JSON in Data property: If the JSON provided in the "Data" field is malformed, the node throws an error: "Data must be a valid JSON". Ensure the JSON syntax is correct before running.
- API Authentication errors: If the API token or secret are invalid or missing, the node will fail with an authentication error. Verify credentials are correctly configured.
- Filter parsing errors: Although not relevant for create, other operations use filters that must be valid JSON; otherwise, errors occur.
- Network issues: Errors like "Network error" indicate connectivity problems to the OnOffice API endpoint.
- Unsupported resource or operation: The node validates resource-operation combinations and throws errors if unsupported.
- API errors: If the OnOffice API returns an error status, the node surfaces the message for troubleshooting.
To resolve errors:
- Double-check JSON formatting.
- Confirm API credentials and permissions.
- Review API limits or restrictions.
- Inspect error messages for specific API feedback.
Links and References
- OnOffice API Documentation (official API docs for detailed data schemas and endpoints)
- n8n documentation on Creating Custom Nodes for general guidance on node development and usage