HumanFirst icon

HumanFirst

Call HumanFirst playbook API

Overview

This node interacts with the HumanFirst API to retrieve metadata about a specific playbook within a given namespace. The "Get Playbook Info" operation fetches detailed information about a playbook, which can be useful for understanding its configuration, status, or other metadata before performing further actions such as running workflows or managing prompts.

Common scenarios where this node is beneficial include:

  • Automating retrieval of playbook details for monitoring or reporting.
  • Integrating playbook metadata into larger automation workflows.
  • Validating playbook existence and properties before triggering pipelines or updates.

Example: You want to check the current configuration of a playbook identified by its ID in your namespace before running an analysis pipeline on it.

Properties

Name Meaning
Namespace The namespace under which the playbook exists. This scopes the request to a particular environment or tenant.
Playbook ID The unique identifier of the playbook whose metadata you want to retrieve.

Output

The output JSON contains the full metadata response from the HumanFirst API for the specified playbook. This typically includes fields describing the playbook's configuration, status, associated pipelines, prompts, and other relevant details.

The node does not output binary data for this operation.

Example output structure (simplified):

{
  "id": "playbook-id",
  "name": "Playbook Name",
  "description": "Description of the playbook",
  "pipelines": [...],
  "prompts": [...],
  "createdAt": "...",
  "updatedAt": "..."
}

Dependencies

  • Requires an API key credential for authenticating with the HumanFirst API.
  • The node uses HTTP requests to the HumanFirst API endpoints.
  • The user must configure the HumanFirst API credentials in n8n with appropriate permissions to read playbook data.

Troubleshooting

  • Missing or invalid Namespace or Playbook ID: Ensure both are provided and correct; otherwise, the API will return errors or empty results.
  • Authentication errors: Verify that the API key credential is valid and has access rights to the requested namespace and playbook.
  • Network or API errors: Check connectivity and API availability. The node surfaces error messages returned by the API.
  • Unexpected response format: If the API changes, the node may receive unexpected data. Review API documentation or update the node accordingly.

Links and References

Discussion