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 Create operation, the node allows users to create a new agent log entry in the OnOffice system.

Common scenarios where this node is beneficial include automating the creation of agent log entries when certain events occur in your workflow, such as logging interactions or updates related to real estate agents within your CRM or property management system.

For example, you might use this node to automatically create an agent log entry whenever a new property listing is added or updated, helping maintain a detailed activity history without manual input.

Properties

Name Meaning
Include Debug Info Whether to include debug information in the output. If enabled, the node returns detailed raw API response and request data for troubleshooting purposes.

Output

The node outputs a JSON object containing the result of the create operation. The structure includes:

  • success: A boolean indicating if the operation was successful.
  • resourceType: The resource involved (e.g., "agentslog").
  • operation: The operation performed ("create").
  • data: An array that would typically contain the created record's details (empty in the current implementation).
  • If debug info is enabled, additional fields are included:
    • 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.

If the operation fails and the node is set to continue on failure, the output will include:

  • success: false
  • error: The error message returned.
  • resourceType and operation for context.

The node does not output binary data.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • Needs proper credentials configured in n8n to access the OnOffice API.
  • Uses the OnOffice API endpoints:
    • Stable API: https://api.onoffice.de/api/stable/api.php (used only for relation getMany)
    • Latest API: https://api.onoffice.de/api/latest/api.php (used for other requests)

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect resource or operation parameters may lead to API errors.
    • Network issues or API downtime can cause request failures.

  • Error Messages:

    • "OnOffice API error: <message>": Indicates an error response from the API. Check the message for details.
    • Unknown errors may be reported if the API response lacks expected status codes.

  • Resolutions:

    • Verify that the API token and secret are correctly configured.
    • Ensure the resource and operation parameters match supported values.
    • Enable "Include Debug Info" to get detailed request and response data for diagnosing issues.
    • Use the "Continue on Fail" option to handle errors gracefully in workflows.

Links and References

Discussion