HumanFirst

Call HumanFirst playbook API

Actions13

Overview

This node integrates with the HumanFirst platform to manage and interact with playbooks, pipelines, prompts, and related data. Specifically, the Update Playbook Pipeline operation allows users to update certain fields of a pipeline within a specified playbook and namespace. Currently, it supports updating the date filter on the pipeline steps to the current day.

Typical use cases include:

Automatically refreshing or adjusting pipeline filters daily to ensure data queries reflect the current date.
Managing playbook pipelines programmatically as part of an automation workflow.
Integrating HumanFirst playbook pipeline updates into larger data processing or AI workflows.

Example: A user wants to update the date range filter on a pipeline's data query predicates every day to always cover "today". This node operation sets that date range automatically.

Properties

Name	Meaning
Namespace	The namespace in which the playbook resides. Required for identifying the scope of the playbook.
Playbook ID	The unique identifier of the playbook containing the pipeline to update.
Pipeline ID	The unique identifier of the pipeline within the playbook to update.
Update Mask (Comma-Separated)	Comma-separated list of pipeline field paths to update. Currently, only `steps.dataQuery.queries.query.predicates` is supported. Must be non-empty.
Apply To All Steps?	Boolean flag indicating whether to apply the update to all matching items from the payload (`true`) or only those specified in the update mask (`false`).

Output

The output JSON contains the response from the HumanFirst API after updating the pipeline. It includes the updated pipeline object reflecting the changes made.

The structure typically looks like:

{
  "namespace": "string",
  "playbook_id": "string",
  "pipeline_id": "string",
  "pipeline": {
    "steps": [
      {
        "dataQuery": {
          "queries": [
            {
              "query": {
                "@type": "type.googleapis.com/zia.ai.playbook.SimpleQueryRequest",
                "predicates": [
                  {
                    "date": {
                      "start": "ISO8601 string",
                      "end": "ISO8601 string"
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  },
  "update_mask": "string",
  "update_all": boolean
}

No binary data is output by this operation.

Dependencies

Requires an API key credential for HumanFirst API authentication.
The node makes HTTP requests to the HumanFirst API endpoints using the base URL and API version configured in the credentials.
The node expects the HumanFirst API to support PUT requests to update pipelines at the endpoint pattern:
/playbooks/{namespace}/{playbookId}/pipelines/{pipelineId}

Troubleshooting

Error: "update_mask must be a non-empty comma-separated list of field paths"
This error occurs if the update_mask property is empty or whitespace. Ensure you provide a valid, non-empty comma-separated string. Currently, only "steps.dataQuery.queries.query.predicates" is supported.
API Authentication Errors
If the API key is missing, invalid, or expired, the request will fail. Verify your HumanFirst API key credential is correctly configured.
Invalid Pipeline or Playbook IDs
If the specified playbook or pipeline IDs do not exist or are incorrect, the API will return an error. Double-check these identifiers.
Network or API Endpoint Issues
Ensure network connectivity to the HumanFirst API and that the base URL and API version in credentials are correct.

Links and References

HumanFirst API Documentation (general reference for API endpoints and usage)
n8n Documentation - Creating Custom Nodes
ISO 8601 Date Format (for date strings used in predicates)

If you need details about other operations or resources, please specify!

HumanFirstInstall