onOffice icon

onOffice

Consume onOffice API

Actions14

Overview

This node integrates with the onOffice API to manage address data within the onOffice system. Specifically, the Address - Create operation allows users to create new contact addresses by specifying various contact details such as salutation, name, email, phone, and location information.

Common scenarios for this node include:

  • Adding new contacts or clients into the onOffice CRM system automatically from form submissions or other data sources.
  • Synchronizing external contact databases with onOffice by creating new address entries.
  • Automating contact creation workflows in real estate or property management contexts where onOffice is used.

Example: Automatically create a new contact address in onOffice when a lead fills out a web form, including their name, email, phone number, and address details.

Properties

Name Meaning
Salutation Salutation for the contact; options are "Mr", "Ms", or "Company".
First Name First name of the contact.
Last Name Last name (surname) of the contact.
Email Email address of the contact.
Phone Phone number of the contact.
Street Street name of the contact's address.
Postal Code Postal code of the contact's address.
City City where the contact is located.
Country Country where the contact is located; defaults to "Deutschland" (Germany).
User User responsible for this contact (likely an internal user identifier or name).

These fields are grouped under a fixed collection named "Fields" → "Address Fields" and are used to specify the details of the address/contact being created.

Output

The node outputs JSON data representing the response from the onOffice API after attempting to create the address. The output structure includes:

  • resourceType: Always set to "address" indicating the type of resource processed.
  • Other fields correspond to the created address record returned by the API, typically including identifiers and the submitted contact details.
  • If the API returns no results or the response cannot be parsed, the output will contain a success message with the raw API response.
  • In case of errors, the output may contain an error message and the raw request details if "Continue On Fail" is enabled.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the onOffice API. This credential must provide an API token and secret.
  • The node uses HMAC SHA256 signing for request authentication.
  • HTTP requests are made to the onOffice stable API endpoint at https://api.onoffice.de/api/stable/api.php.
  • No additional external dependencies beyond the onOffice API and n8n's built-in HTTP request helper.

Troubleshooting

  • No credentials provided: The node will throw an error if the required API credentials are missing. Ensure that valid API authentication tokens are configured in n8n.
  • Invalid resource or operation: If the resource or operation parameters are incorrect, the node throws an error indicating invalid input.
  • API errors: If the onOffice API returns an error status code, the node surfaces the API error message. Check the API token validity, permissions, and request parameters.
  • Missing required fields: For some operations like task creation, required fields must be provided. For address creation, ensure mandatory fields like last name or email are correctly set if required by the API.
  • Parsing issues: If the API response format changes or is unexpected, the node may fail to parse results properly, resulting in a generic success message with raw response data.

Links and References

Discussion