OnOffice icon

OnOffice

Consume OnOffice API

Actions30

Overview

This node integrates with the OnOffice API to manage various resources such as estates, addresses, relations, agent logs, tasks, and IDs from relations. Specifically for the Task resource with the Update operation, it updates an existing task record identified by its ID.

Typical use cases include:

  • Updating details of a task in a real estate management workflow.
  • Automating task status or content changes based on external triggers.
  • Synchronizing task information between OnOffice and other systems.

For example, you might update a task's subject or other fields after receiving new information from another system or user input.

Properties

Name Meaning
ID The unique identifier of the task record to update. This is required to specify which task to modify.
Include Debug Info Boolean flag to include detailed debug information in the output, useful for troubleshooting API requests.

Output

The node outputs JSON data structured as follows:

  • If Include Debug Info is false (default), the output JSON contains:

    {
  "success": true,
  "resourceType": "task",
  "operation": "update",
  "data": []
}

    This indicates the update was successful; the data array is empty because the API does not return updated object details.

  • If Include Debug Info is true, the output includes:

    • debug: set to true
    • rawResponse: the full raw response from the OnOffice API
    • requestSent: the exact request payload sent to the API
    • url: the API endpoint URL used

  • In case of failure (and if the node is configured to continue on fail), the output JSON includes:

    {
  "success": false,
  "error": "<error message>",
  "resourceType": "task",
  "operation": "update"
}

The node does not output binary data.

Dependencies

  • Requires an API authentication token and secret credential for the OnOffice API.
  • Uses the OnOffice API endpoint: https://api.onoffice.de/api/latest/api.php (or a legacy endpoint for some resources).
  • The node internally generates HMAC signatures for request authentication.
  • No additional external dependencies beyond the OnOffice API and n8n's HTTP request helper.

Troubleshooting

  • Common issues:

    • Invalid or missing task ID will cause the API to reject the update request.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity problems can cause request failures.

  • Error messages:

    • "OnOffice API error: <message>" indicates the API returned an error status. Check the error message for details.
    • If the node throws an error about missing parameters, ensure the required ID field is provided.
    • Enabling Include Debug Info helps diagnose issues by showing the raw API request and response.

  • Resolution tips:

    • Verify that the task ID exists and is correct.
    • Confirm API credentials are valid and have necessary permissions.
    • Use debug info to inspect request payloads and API responses.
    • Ensure network access to the OnOffice API endpoint.

Links and References

Discussion