Overkiz (Tahoma) icon

Overkiz (Tahoma)

Interact with Overkiz (Tahoma) API

Actions3

Overview

This node allows you to interact with the Overkiz (Tahoma) API, specifically to retrieve information about a single object (device) managed by Overkiz. The "Get Single" operation fetches detailed data for a specific object, which can be selected from a list or specified by its ID. This is useful in scenarios where you need to obtain the current state or properties of a particular device, such as a smart thermostat, light, or other connected home automation equipment.

Practical examples:

  • Retrieve the status of a specific smart device (e.g., check if a window is open).
  • Get all available details for a device before performing further automation.
  • Use the output as input for subsequent workflow steps, such as conditional logic or notifications.

Properties

Name Meaning
Object Name or ID Object to perform action upon. Choose from the list of available objects, or specify an ID using an expression.

Output

The node outputs a single item in the json field containing all available data for the selected object. The structure includes all properties returned by the Overkiz API for that object, such as:

  • name: The name of the object/device.
  • URL: The unique identifier for the object.
  • definition: Metadata about the object, including its type and capabilities.
  • widget: The widget type of the object.
  • Other device-specific fields as provided by the Overkiz API.

Example output:

{
  "name": "Living Room Window",
  "URL": "io://1234-5678-9012/12345678",
  "definition": {
    "uiClass": "Window",
    // ...other metadata
  },
  "widget": "Window",
  // ...additional properties
}

Dependencies

  • External Service: Requires access to the Overkiz (Tahoma) API.
  • Credentials: You must configure valid Overkiz API credentials in n8n under the name overkizApi.

Troubleshooting

  • Missing Credentials:
    Error: No credentials!
    Solution: Ensure you have set up and selected the correct Overkiz API credentials in your n8n instance.

  • Invalid Object ID:
    If the specified Object Name or ID does not exist, the node will return an empty result or may fail to retrieve data. Double-check the object selection or expression.

  • API Connectivity Issues:
    Network or authentication errors may occur if the Overkiz API is unreachable or credentials are invalid. Verify network access and credential validity.

Links and References

Discussion