Create Task Soar icon

Create Task Soar

Create Task in Soar

Overview

This node, named "Create Task Soar," is designed to create tasks in a Soar API service by sending task details via HTTP POST requests. It is useful in automation workflows where tasks need to be programmatically created and managed within a Soar system, such as incident response platforms or security orchestration tools.

Typical use cases include:

  • Automatically creating new tasks based on incoming data or events.
  • Integrating Soar task creation into larger automated processes.
  • Managing task metadata like priority, SLA, attachments, and status through workflow inputs.

For example, a security operations team could use this node to automatically generate investigation tasks when alerts are received from monitoring systems.

Properties

Name Meaning
Url of Soar API The endpoint URL for the Soar API service where the task will be created (e.g., http://192.168.143.73:2025/api/tasks).
Type Numeric type identifier of the task (e.g., 1).
Name Name/title of the task to be created.
Code Unique code identifier for the task.
Department Code Code representing the department responsible for the task.
Case Code Code of the case associated with the task.
Username Username of the user who is creating the task.
Catalog Priority Code Priority code indicating the urgency or importance of the task.
SLA Code Service Level Agreement code defining expected handling time or conditions.
Description Detailed description of the task.
Status Numeric status code of the task (e.g., 0).
Attachment IDs JSON string representing an array of attachment IDs linked to the task (e.g., [422]).
Tenancy Code Optional tenancy code related to multi-tenant environments.

Output

The node outputs an array of JSON objects, one per input item processed. Each output object contains:

  • success: Boolean indicating if the task creation was successful.
  • response: The full response returned by the Soar API after creating the task.
  • name: The name of the task that was attempted to be created.
  • In case of failure, it includes:
    • error: Error message describing what went wrong.
    • statusCode: HTTP status code returned by the API or error.
    • response: Response body or text from the API if available.
    • caseName: The case name parameter if provided (used internally for logging).

The node does not output binary data.

Dependencies

  • Requires access to a Soar API endpoint capable of receiving task creation requests.
  • Needs an API authentication token credential configured in n8n (referred generically as "an API key credential").
  • The node sends HTTP POST requests with JSON payloads and includes the token in the request headers.
  • The Accept-Language header is set to Vietnamese (vi), which may affect localization of responses.

Troubleshooting

  • Common issues:

    • Invalid or unreachable Soar API URL causing connection errors.
    • Missing or invalid API authentication token leading to authorization failures.
    • Malformed JSON in the attachmentIds property causing parsing errors.
    • Incorrect or missing required properties resulting in API validation errors.

  • Error messages:

    • Errors include detailed messages, HTTP status codes, and response bodies when available.
    • If the node is set to continue on fail, errors are captured in the output JSON; otherwise, execution stops with a descriptive error.
    • Common resolution steps include verifying API URL correctness, ensuring valid credentials, and checking that all required fields are properly set.

Links and References

  • No direct external links are embedded in the source code.
  • Users should refer to their Soar API documentation for details on task creation endpoints and required parameters.
  • For general n8n usage, see n8n Documentation.

Discussion