OnOffice icon

OnOffice

Consume OnOffice API

Actions15

Overview

This node integrates with the OnOffice API to manage various real estate-related resources, including tasks. Specifically, for the Task - Create operation, it allows users to create new tasks within the OnOffice system. This is useful for automating task creation related to real estate contacts or activities, such as scheduling follow-ups, assigning responsibilities, or tracking actions.

Typical scenarios include:

  • Automatically creating a task when a new lead is added.
  • Assigning a responsible user to a task related to a specific contact.
  • Adding descriptive details to tasks for better context and tracking.

Example: Creating a task with a subject "Call client", assigning it to a user, and linking it to a contact's address ID.

Properties

Name Meaning
Subject The title or main topic of the task (required).
Task Description A detailed description or notes about the task.
Responsible User The user assigned to be responsible for completing the task.
Related Address ID The ID of the related contact/address associated with the task.

Output

The node outputs JSON data representing the result of the API call to create the task. The output includes:

  • success: Boolean indicating if the operation was successful.
  • resourceType: The resource type, here always "task".
  • operation: The operation performed, here "create".
  • data: An object containing the created task's data returned by the API.
  • message: Optional message from the API response.
  • rawResponse: The full raw API response for debugging purposes.

If an error occurs, the output will contain error details including the error message and any API error response.

Dependencies

  • Requires an API authentication token and secret credential for the OnOffice API.
  • The node makes HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • HMAC signature generation is used for request authentication.
  • No additional external dependencies beyond the OnOffice API and n8n credentials.

Troubleshooting

  • Invalid JSON in Data Property: If the input data JSON is malformed, the node throws an error "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • API Request Failed: Network issues or invalid credentials can cause request failures. Check API token and secret validity.
  • Unsupported Resource or Operation: Errors occur if unsupported resource or operation names are provided.
  • API Action Error: If the API returns an error code, the node surfaces the message. Verify that all required fields are correctly set and that the API limits or permissions are respected.
  • Use the debug output (debug: true) included in the response to inspect raw API requests and responses for troubleshooting.

Links and References

Discussion