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 related to contacts (addresses). This is useful for tracking communications or interactions such as calls, emails, meetings, or notes associated with agents and their contacts.

Common scenarios include:

  • Logging a phone call or email interaction with a client.
  • Recording meeting details or notes about an agent's activity.
  • Keeping a history of agent actions linked to specific contacts for better CRM management.

Example: A real estate agent wants to log a follow-up call made to a potential buyer. Using this node, they can create an agent log entry specifying the contact's address ID, the type of action ("Call"), direction ("Outgoing"), and any notes about the conversation.

Properties

Name Meaning
Address IDs ID(s) of the address(es) (contacts) related to the agent log entry.
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 (free text).

Output

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

  • success: Boolean indicating if the creation was successful.
  • resourceType: The resource involved, here always "agentslog".
  • operation: The operation performed, here "create".
  • data: The data returned by the API representing the created agent log entry.
  • message: Optional message from the API response.
  • rawResponse: The full raw response from the OnOffice API for debugging purposes.

If the API request fails, the output will contain error information including the error message and optionally the error response from the API.

The node does not output binary data.

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • The node sends HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • HMAC signature generation is used for request authentication.
  • Proper configuration of the API credentials in n8n is necessary.

Troubleshooting

  • Invalid JSON Data: If the input data for other resources (not relevant here but in general) is malformed JSON, the node throws an error. For Agent Log creation, ensure all required fields are correctly filled.
  • API Request Failed: Network issues or invalid credentials may cause the API request to fail. Check API token and secret validity.
  • API Action Error: If the API returns an error code, the node surfaces the error message. Verify that the provided address IDs exist and that the action kind and type values are valid.
  • Unsupported Resource/Operation: Attempting to use unsupported combinations will throw errors. Ensure the resource is set to "Agent Log" and operation to "Create".

Using the "Continue on Fail" option in n8n can help handle errors gracefully during batch processing.

Links and References

Discussion