OnOffice icon

OnOffice

Consume OnOffice API

Actions15

Overview

This node integrates with the OnOffice API to manage various real estate-related resources. Specifically, for the Agent Log - Create operation, it allows users to create new agent log entries that record activities performed by agents related to contacts (addresses). This is useful for tracking communications and interactions such as calls, emails, meetings, or notes associated with specific contacts.

Practical scenarios include:

  • Logging a phone call made to a client.
  • Recording an email sent or received.
  • Documenting meetings or notes about client interactions.
  • Keeping a history of agent activities linked to contact IDs.

This helps real estate agencies maintain detailed records of their agent's activities for better customer relationship management and auditing.

Properties

Name Meaning
Address IDs ID(s) of the address(es) (contacts) for which the agent log entry is created.
Action Kind Type of agent activity. Options: Call, Email, Meeting, Note.
Action Type Direction of the activity. Options: Incoming, Outgoing.
Note Additional note or details about the agent activity.

Output

The node outputs a JSON object containing the result of the API request. For a successful creation, the output includes:

  • success: Boolean indicating if the operation was successful.
  • resourceType: The resource involved, here "agentslog".
  • operation: The operation performed, here "create".
  • data: The data returned from the API about the created agent log entry.
  • message: Optional message from the API response.
  • rawResponse: The full raw API response for debugging purposes.
  • debug: A flag set to true indicating debug information is included.

If the API request fails, the output contains error details including the error message and any error response from the API.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • Needs the OnOffice API credentials configured in n8n (an API key credential and secret).
  • Makes HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Uses HMAC signature generation for request authentication.

Troubleshooting

  • Invalid JSON Data: If the input data is malformed JSON, the node throws an error. Ensure the JSON syntax is correct when providing data.
  • API Authentication Errors: Missing or incorrect API token/secret will cause authentication failures. Verify credentials are correctly set up.
  • Unsupported Resource or Operation: Using unsupported combinations will throw errors. Confirm that the resource is "agentslog" and operation is "create" for this use case.
  • API Request Failures: Network issues or API downtime can cause request failures. Check network connectivity and OnOffice API status.
  • Error Messages: The node surfaces API error messages; review these to understand issues like invalid parameters or permission problems.

Using the "Continue on Fail" option can help handle errors gracefully in workflows.

Links and References

Discussion