onOffice icon

onOffice

Consume onOffice API

Actions14

Overview

This node integrates with the onOffice API, a real estate management platform, to perform various operations on different resources such as tasks, estates, addresses, and searches. Specifically for the Task - Get operation, it retrieves detailed information about a single task by its ID.

Common scenarios where this node is beneficial include:

  • Fetching details of a specific task related to real estate management workflows.
  • Automating task tracking and updates within n8n workflows.
  • Integrating task data from onOffice into other systems or dashboards.

For example, you can use this node to get the details of a task assigned to a user, then trigger notifications or update CRM records based on the task status.

Properties

Name Meaning
Task ID The unique identifier of the task to retrieve. This is required for the "Get" and "Delete" operations on the Task resource.

Output

The node outputs JSON data representing the retrieved task's details. The structure includes fields such as:

  • id: The task's unique identifier.
  • Betreff: The subject or title of the task.
  • Aufgabe: The description or content of the task.
  • relatedAddressId: ID of the related address, if any.
  • relatedEstateId: ID of the related estate, if any.
  • Verantwortung: The user responsible for the task.
  • Angelegt am: Creation timestamp.
  • Geaendert am: Last modified timestamp.
  • resourceType: Always set to "task" to indicate the type of resource returned.

If no results are found or the response cannot be parsed, the output will contain a success message indicating no results were found along with the raw API response.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the onOffice API.
  • The node makes HTTP POST requests to https://api.onoffice.de/api/stable/api.php.
  • Uses HMAC SHA256 signing for request authentication, requiring both an API token and secret.
  • Requires proper configuration of credentials in n8n to access the onOffice API.

Troubleshooting

  • No credentials provided: The node will throw an error if the API credentials are missing. Ensure that the API key and secret are configured correctly in n8n.
  • Invalid resource or operation: If an unsupported resource or operation is selected, the node throws an error indicating invalid input.
  • API errors: If the onOffice API returns an error (non-200 status code), the node surfaces the API error message. Check the API token validity, permissions, and request parameters.
  • Missing Task ID: For the "Get" operation on tasks, the Task ID must be provided; otherwise, the node will fail.
  • Parsing issues: If the API response format changes or is unexpected, the node may not parse results correctly and will return a message indicating no results found.

To resolve these issues:

  • Verify credentials and permissions.
  • Confirm that the Task ID exists and is correct.
  • Review API limits or restrictions on the onOffice side.
  • Enable "Continue On Fail" in the node settings to handle errors gracefully in workflows.

Links and References

Discussion