onOffice icon

onOffice

Consume onOffice API

Actions14

Overview

This node integrates with the onOffice API to manage tasks within a real estate context. Specifically, the Task - Create operation allows users to create new tasks by providing details such as title, description, assigned user, and related entities like addresses or estates.

Common scenarios where this node is beneficial include:

  • Automating task creation when new leads or properties are added.
  • Assigning follow-up actions to team members automatically.
  • Linking tasks to specific addresses or estates for better tracking.

For example, a real estate agent could use this node to automatically create a task titled "Contact client" assigned to a specific user whenever a new property inquiry is received, linking it to the relevant address or estate.

Properties

Name Meaning
Task Details A collection of fields describing the task to create:
- Title Title of the task (required). Example: "Follow up with client".
- Description Detailed description of the task. Example: "Call the client to discuss property options."
- Assign to User ID of the user responsible for the task.
- Related Address ID ID of an address entity related to this task.
- Related Estate ID ID of an estate entity related to this task.

Output

The node outputs JSON data representing the created task record returned from the onOffice API. The output includes all fields provided by the API response, augmented with a resourceType field set to "task" to indicate the type of resource.

Example output structure (simplified):

{
  "id": "12345",
  "Betreff": "Follow up with client",
  "Aufgabe": "Call the client to discuss property options.",
  "Verantwortung": "userId123",
  "relatedAddressId": "addressId456",
  "relatedEstateId": "estateId789",
  "Angelegt am": "2024-06-01T12:00:00Z",
  "Geaendert am": "2024-06-01T12:00:00Z",
  "resourceType": "task"
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API authentication token and secret credential for the onOffice API.
  • Makes HTTP POST requests to https://api.onoffice.de/api/stable/api.php.
  • Uses HMAC SHA256 signing for request authentication.
  • Requires n8n credentials configuration with valid API keys for onOffice.

Troubleshooting

  • Missing Task Title Error: If the "Title" property is not provided, the node throws an error stating that the task title is required. Ensure the title field is filled.
  • Invalid Resource or Operation: If the resource or operation parameters are incorrect, the node will throw an error indicating invalid resource/operation.
  • API Errors: If the onOffice API returns an error status code, the node surfaces the API error message. Check API credentials and request parameters.
  • Network Issues: Connectivity problems to the onOffice API endpoint may cause failures. Verify network access and API availability.
  • Continue On Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References

Discussion