Dokka icon

Dokka

Interact with Dokka API

Overview

This node interacts with the Dokka API to retrieve metadata for a specific public document. It is useful when you need to fetch detailed information about a document stored or managed within the Dokka system, such as its properties, status, or other metadata fields.

Common scenarios include:

  • Automating document management workflows by fetching document details before processing.
  • Integrating Dokka document metadata into other systems or dashboards.
  • Validating document existence and attributes before further actions.

Example: You have a document ID and company ID, and you want to get metadata like creation date, author, or status to decide if it should be archived or sent for review.

Properties

Name Meaning
Document Id The unique identifier of the document whose metadata you want to retrieve.
Company ID The identifier of the company in Dokka to which the document belongs.
X Fields Optional header field to specify a mask of fields to return, limiting the metadata scope.

Output

The node outputs JSON data containing the metadata of the specified document. This typically includes various descriptive fields about the document such as title, author, creation date, modification date, status, and any other metadata exposed by the Dokka API.

If the "X Fields" property is used, the output will be limited to only those fields specified.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Dokka API via an API key or authentication token configured in the node credentials.
  • The base URL for the Dokka API must be set in the node's credential configuration.
  • Network access to the Dokka API endpoint is necessary.

Troubleshooting

  • Missing or invalid Document Id or Company ID: The node requires both IDs to be provided; missing or incorrect values will cause errors.
  • Authentication errors: Ensure that the API key or authentication token is valid and has sufficient permissions.
  • Network issues: Verify connectivity to the Dokka API base URL.
  • Invalid X Fields value: If the optional fields mask is malformed or requests non-existent fields, the API may return errors or incomplete data.

Common error messages might include HTTP 400 (bad request), 401 (unauthorized), or 404 (document not found). Check input parameters and credentials accordingly.

Links and References

  • Dokka API Documentation (refer to your internal or official Dokka API docs for detailed metadata schema and usage)
  • n8n Documentation on HTTP Request Nodes and Credential Setup

Discussion