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 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, this node can create a corresponding task in the Soar platform with all relevant metadata like department, case code, priority, and description.

Properties

Name Meaning
Url of Soar API The endpoint URL for the Soar API service (e.g., http://192.168.143.73:2025/api/tasks).
Type Type of the task (numeric value, e.g., 1).
Name Name of the task.
Code Code identifier of the task.
Department Code Department code associated with the task.
Case Code Case code linked to the task.
Username Username of the user creating the task.
Catalog Priority Code Priority code assigned to the task.
SLA Code Service Level Agreement code for the task.
Description Description text explaining the task.
Status Numeric status of the task (e.g., 0).
Attachment IDs JSON string representing an array of attachment IDs related to the task (e.g., [422]).
Tenancy Code Optional tenancy code for 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.
  • name: The name of the task created.
  • error (only if failure): Error message describing what went wrong during task creation.

No binary data is produced by this node.

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 JSON payloads to the specified Soar API URL.
  • The request includes a header with the token for authentication and sets the language preference to Vietnamese (Accept-Language: vi).

Troubleshooting

  • Common issues:

    • Invalid or unreachable Soar API URL will cause connection errors.
    • Missing or invalid API token will result in authorization failures.
    • Malformed JSON in the attachmentIds property may cause parsing errors.
    • Required properties missing or empty will likely cause the API to reject the request.

  • Error messages:

    • Errors thrown during HTTP requests are logged and can either stop execution or be captured per item if "Continue On Fail" is enabled.
    • Typical error messages include network errors, unauthorized access, or validation errors returned by the Soar API.

  • Resolutions:

    • Verify the Soar API URL and ensure it is accessible from the n8n environment.
    • Confirm the API token credential is correctly set up and has necessary permissions.
    • Ensure attachmentIds is a valid JSON array string.
    • Fill all required fields with valid values before executing the node.

Links and References

  • HTTP Request Node Documentation
  • Soar API documentation (refer to your Soar platform's official API docs for task creation endpoints and payload structure)

Discussion