Outline icon

Outline

Interact with Outline knowledge base

Overview

This node interacts with the Outline knowledge base API, specifically managing groups when the "Group" resource and "Get" operation are selected. It retrieves detailed information about a specific group by its ID. This is useful in scenarios where you need to fetch metadata or properties of a group within your Outline workspace, such as for auditing, reporting, or conditional workflow branching based on group attributes.

Practical example:
You have an automation that triggers when a new document is created and you want to check which group owns or manages that document. Using this node with the "Get" operation on the "Group" resource, you can retrieve the group's details by providing its ID.

Properties

Name Meaning
Group ID The unique identifier of the group to retrieve information about.

Output

The output is a JSON object containing the full details of the requested group as returned by the Outline API's /groups.info endpoint. This typically includes fields such as the group's ID, name, creation date, members, and other metadata related to the group.

The output structure is:

{
  "id": "string",
  "name": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "members": [
    {
      "id": "string",
      "name": "string",
      ...
    }
  ],
  ...
}

The exact fields depend on the Outline API response but generally provide comprehensive group information.

Dependencies

  • Requires an API key credential for authenticating requests to the Outline API.
  • The node uses the Outline API endpoints via HTTP POST requests.
  • No additional external dependencies beyond the configured Outline API credentials.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Group ID will result in an error from the Outline API indicating the group was not found.
    • Missing or incorrect API authentication credentials will cause authorization errors.
    • Network connectivity issues may prevent successful API calls.
  • Error messages:

    • "Group not found": Verify the Group ID is correct and exists in your Outline workspace.
    • "Unauthorized" or similar: Check that the API key credential is valid and has sufficient permissions.
    • Timeout or network errors: Ensure your environment has internet access and the Outline API is reachable.
  • To resolve errors, confirm input parameters, verify credentials, and check network connectivity.

Links and References

Discussion