OnOffice icon

OnOffice

Consume OnOffice API

Actions30

Overview

This node integrates with the OnOffice API to manage various resources such as estates, addresses, agent logs, relations, tasks, and IDs from relations. Specifically for the Relation resource with the Create operation, it allows users to create a new relation record in the OnOffice system.

Common scenarios where this node is beneficial include automating the creation of contact or client records (relations) within a real estate management workflow, syncing external CRM data into OnOffice, or programmatically adding new relations based on form submissions or other triggers.

For example, a user could automate adding a new client relation whenever a lead is captured on their website, ensuring the OnOffice database stays up-to-date without manual entry.

Properties

Name Meaning
Include Debug Info Whether to include detailed debug information in the output. When enabled, the node returns raw API responses and request details useful for troubleshooting.

Note: The bundled code shows that the node supports other properties like Resource, Operation, and ID, but since the focus is on Relation-Create and only "Include Debug Info" was provided, only that property is described here.

Output

The node outputs JSON data structured as follows:

  • If Include Debug Info is enabled:

    • debug: Boolean true indicating debug mode.
    • rawResponse: The full raw response object returned by the OnOffice API.
    • requestSent: The exact request payload sent to the API.
    • url: The API endpoint URL used.

  • Otherwise:

    • success: Boolean true indicating the operation succeeded.
    • resourceType: The resource acted upon, e.g., "relation".
    • operation: The operation performed, e.g., "create".
    • data: An array containing the created record's data (empty in the provided snippet, but typically would contain the created relation details).

If an error occurs and the node is set to continue on failure, the output includes:

  • success: false
  • error: Error message string
  • 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.
  • Uses HMAC signature generation for authentication.
  • Makes HTTP POST requests to the OnOffice API endpoints:
    • For Relation resource with Create operation, the endpoint is https://api.onoffice.de/api/latest/api.php.
  • Requires n8n environment configured with these credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect or missing required parameters (e.g., missing data fields when creating a relation) may result in API errors.
    • Network connectivity problems can cause request failures.

  • Error messages:

    • "OnOffice API error: <message>" indicates the API returned an error status. The message provides details from the API.
    • Unknown errors may occur if the API response is malformed or unexpected.

  • Resolution tips:

    • Verify API token and secret are correctly configured.
    • Enable "Include Debug Info" to get detailed request and response data for diagnosing issues.
    • Check that all required input fields for creating a relation are provided.
    • Ensure network access to the OnOffice API endpoint.

Links and References

Discussion