HumanFirst

Call HumanFirst playbook API

Actions13

Overview

This node integrates with the HumanFirst API to manage and interact with playbooks and their prompts. Specifically, the List Prompts operation retrieves all prompts defined within a specified playbook in a given namespace.

Use cases include:

Fetching all prompts for review or processing in automation workflows.
Synchronizing prompt data from HumanFirst into other systems.
Building dashboards or reports based on existing prompts in a playbook.

Example: You have a playbook managing customer support dialogues and want to list all prompts to analyze or update them programmatically.

Properties

Name	Meaning
Namespace	The namespace under which the playbook exists. This is a required string identifying the scope of the playbook.
Playbook ID	The unique identifier of the playbook whose prompts you want to list. Required string.

Output

The output contains a JSON object representing the response from the HumanFirst API endpoint that lists prompts for the specified playbook. The structure typically includes an array of prompt objects with their details such as IDs, names, contents, parameters, and metadata.

No binary data is output by this operation.

Example output snippet (simplified):

{
  "prompts": [
    {
      "id": "prompt1",
      "name": "Greeting Prompt",
      "contents": "Hello! How can I help you today?",
      "metadata": { ... },
      ...
    },
    {
      "id": "prompt2",
      "name": "Farewell Prompt",
      "contents": "Thank you for contacting us. Goodbye!",
      "metadata": { ... },
      ...
    }
  ]
}

Dependencies

Requires an API key credential for authenticating with the HumanFirst API.
The node makes HTTP GET requests to the HumanFirst API endpoint /workspaces/{namespace}/{playbookId}/prompts.
Proper network connectivity to the HumanFirst API service is necessary.
No additional environment variables are explicitly required beyond the API key credential.

Troubleshooting

Missing or invalid Namespace or Playbook ID: The node requires both properties to be set correctly. Ensure these values are accurate and correspond to existing resources in your HumanFirst account.
Authentication errors: If the API key credential is missing, expired, or incorrect, the request will fail. Verify the API key and re-authenticate if needed.
API rate limits or service downtime: Temporary failures may occur due to rate limiting or HumanFirst service issues. Retry after some time or check service status.
Unexpected response format: If the API changes or returns errors, the node might output error messages in the JSON. Review the error message for clues.

Links and References

HumanFirst API Documentation (general reference for API endpoints)
n8n Expressions and Parameters (for dynamic property usage)

This summary focuses solely on the List Prompts operation of the HumanFirst node's default resource, based on static analysis of the provided source code and input property definitions.

HumanFirstInstall