OnOffice icon

OnOffice

Consume OnOffice API

Actions30

Overview

This node integrates with the OnOffice API to perform various operations on different resources such as estates, addresses, agent logs, relations, tasks, and IDs from relations. Specifically, for the Agent Log resource with the Delete operation, the node deletes a specified agent log record by its ID.

Common scenarios where this node is beneficial include automating the management of real estate data, cleaning up outdated or incorrect agent log entries, and integrating OnOffice data workflows into broader automation processes.

For example, you might use this node to automatically delete an agent log entry when a related task is completed or when a certain condition in your CRM system is met.

Properties

Name Meaning
ID The unique identifier of the agent log record to delete. This is required for deletion.
Include Debug Info Boolean flag to include detailed debug information in the output for troubleshooting.

Output

The node outputs a JSON object containing the result of the delete operation:

  • If successful, the output includes:

    • success: true
    • resourceType: "agentslog"
    • operation: "delete"
    • data: An empty array (no additional data returned on delete)

  • If "Include Debug Info" is enabled, the output also contains:

    • debug: 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 "Continue On Fail" is enabled), the output includes:

    • success: false
    • error: Error message describing what went wrong
    • resourceType and operation for context

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:
    https://api.onoffice.de/api/latest/api.php (or a stable endpoint for some resources).
  • The node uses HMAC signature authentication generated from the API token and secret.
  • No other external dependencies are required.

Troubleshooting

  • Common Issues:

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

  • Error Messages:

    • "OnOffice API error: <message>" indicates the API returned an error; check the message for details.
    • If the node throws errors about missing parameters, ensure the required ID is provided.

  • Resolutions:

    • Verify that the API token and secret are correctly configured in the node credentials.
    • Confirm the ID corresponds to an existing agent log record.
    • Enable "Include Debug Info" to get detailed request and response data for debugging.
    • Use the "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

Discussion