onOffice icon

onOffice

Consume onOffice API

Actions14

Overview

This node integrates with the onOffice API to manage various resources such as addresses, estates, searches, and tasks. Specifically, for the Task - Delete operation, it allows users to delete a task by specifying its unique Task ID. This is useful in scenarios where tasks are no longer relevant or were created by mistake and need to be removed from the onOffice system.

Practical examples include:

  • Automatically cleaning up completed or obsolete tasks in your CRM.
  • Removing tasks that were duplicated during data imports.
  • Integrating task deletion into automated workflows triggered by other events.

Properties

Name Meaning
Task ID The unique identifier of the task to delete. This is required to specify which task should be removed from the system.

Output

The node outputs JSON data representing the response from the onOffice API after attempting to delete the specified task. The output includes:

  • A success indicator if the deletion was successful.
  • Raw API response data for further inspection or debugging.
  • In case of failure, an error message describing the issue.

The output structure typically looks like this (simplified example):

{
  "success": true,
  "rawResponse": {
    "status": {
      "code": 200,
      "message": "Task deleted successfully"
    },
    "response": {
      "results": []
    }
  }
}

No binary data is produced by this operation.

Dependencies

  • Requires an active connection to the onOffice API using valid credentials (an API token and secret).
  • The node uses HMAC SHA256 signing for request authentication.
  • Network access to https://api.onoffice.de/api/stable/api.php is necessary.
  • Proper configuration of the API credentials within n8n is mandatory before use.

Troubleshooting

  • Common issues:

    • Missing or invalid Task ID will cause the node to fail.
    • Invalid or missing API credentials will prevent any API calls.
    • Network connectivity problems can cause timeouts or unreachable errors.
    • API errors returned from onOffice (e.g., task not found) will be surfaced as node errors.

  • Error messages:

    • "No credentials provided": Ensure you have configured the required API credentials in n8n.
    • "Invalid resource or operation: task/delete": Indicates a misconfiguration in resource or operation selection.
    • "API Error: <message>": The onOffice API returned an error; check the message for details (e.g., task does not exist).
    • "Task title is required": Not applicable for delete but may appear if create operation is used incorrectly.

  • To resolve errors, verify input parameters, ensure credentials are correct, and confirm network connectivity.

Links and References

Discussion