OnOffice icon

OnOffice

Consume OnOffice API

Actions30

Overview

This node integrates with the OnOffice API to perform various operations on different resource types, including tasks. Specifically, for the Task resource and the Get operation, it retrieves a single task record by its ID from the OnOffice system.

Common scenarios where this node is useful include:

  • Fetching detailed information about a specific task in a real estate management workflow.
  • Automating retrieval of task data to trigger further processing or notifications.
  • Integrating OnOffice task data into other systems or dashboards.

For example, you might use this node to get the details of a task assigned to an agent and then send a reminder email based on the retrieved information.

Properties

Name Meaning
ID The unique identifier of the task record to retrieve. This is required for the Get operation.
Include Debug Info Boolean flag to include detailed debug information in the output, such as raw API response and request details. Useful for troubleshooting.

Output

The node outputs JSON data structured as follows:

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

    {
  "success": true,
  "resourceType": "task",
  "operation": "get",
  "data": []
}
    • success: Indicates if the API call was successful.
    • resourceType: The resource involved ("task").
    • operation: The operation performed ("get").
    • data: An array containing the retrieved task record(s). The exact structure depends on the OnOffice API response.

  • When Include Debug Info is true, the output includes additional fields:

    {
  "debug": true,
  "rawResponse": { /* full API response object */ },
  "requestSent": { /* full request payload sent to API */ },
  "url": "https://api.onoffice.de/api/latest/api.php"
}

    This provides comprehensive insight into the request and response for debugging purposes.

The node does not output binary data.

Dependencies

  • Requires valid credentials for the OnOffice API, specifically an API token and secret.
  • The node makes HTTP POST requests to the OnOffice API endpoint:
    • For the Task resource, the URL used is: https://api.onoffice.de/api/latest/api.php
  • The node uses HMAC signature generation for authentication, requiring both the API token and secret.
  • No additional external dependencies beyond the OnOffice API and n8n's built-in HTTP request helper.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an incorrect or non-existent Task ID will result in an API error indicating the record could not be found.
    • Network connectivity issues can prevent reaching the OnOffice API endpoint.

  • Error Messages:

    • "OnOffice API error: <message>" indicates the API returned an error status. The message usually describes the problem, e.g., invalid ID or permission denied.
    • If the node throws errors related to HMAC signature, verify that the API token and secret are correctly configured.

  • Resolution Tips:

    • Double-check the Task ID input for correctness.
    • Ensure API credentials are up to date and have sufficient permissions.
    • Enable Include Debug Info to get detailed request and response data for diagnosing issues.
    • Confirm network access to https://api.onoffice.de.

Links and References

Discussion