Create Task Soar icon

Create Task Soar

Create Task in Soar
Join our community

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 investigation or remediation tasks based on incoming alerts or events.
  • Integrating with case management systems to track task progress.
  • Assigning tasks with specific priorities, SLAs, and attachments for operational efficiency.

For example, when an alert is received in a security monitoring system, this node can create a corresponding task in the Soar platform with all relevant metadata, ensuring timely follow-up and tracking.

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 associated with the case to which the task belongs.
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 resolution 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, each corresponding to an input item processed. Each output object contains:

  • success: Boolean indicating if the task creation was successful.
  • response: The full response from the Soar API after creating the task (present only if successful).
  • name: The name of the task created.
  • error: Error message string if the task creation failed (present only if unsuccessful).

No binary data is produced by this node.

Example output JSON for a successful task creation:

{
  "success": true,
  "response": { /* API response object */ },
  "name": "Task Name"
}

Example output JSON for a failure:

{
  "success": false,
  "error": "Error message describing what went wrong"
}

Dependencies

  • Requires access to a Soar API endpoint that accepts task creation requests.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The node sends HTTP POST requests with a Bearer token authorization header.
  • The API must accept JSON payloads with the specified task properties.

Troubleshooting

  • Common issues:

    • Invalid or missing API URL: Ensure the "Url of Soar API" property is correctly set and reachable.
    • Authentication failures: Verify that the API token credential is valid and has sufficient permissions.
    • Malformed JSON in "Attachment IDs": This field expects a JSON string representing an array; invalid JSON will cause errors.
    • Network connectivity problems between n8n and the Soar API server.

  • Error messages:

    • Errors during HTTP request (e.g., 401 Unauthorized, 404 Not Found) will be logged and returned in the output's error field.
    • If the node is set to stop on failure, it will throw an error halting execution; otherwise, it continues processing remaining items.

  • Resolution tips:

    • Double-check all required fields are provided and correctly formatted.
    • Test the API endpoint independently using tools like curl or Postman.
    • Enable detailed logging in n8n to capture request/response details for debugging.

Links and References

  • HTTP Request Node Documentation
  • General REST API best practices for task creation endpoints.
  • Soar platform API documentation (if available publicly or internally).

Discussion