Update Task Soar icon

Update Task Soar

Update Task in Soar

Overview

This node, named "Update Task Soar," is designed to update a task in a SOAR (Security Orchestration, Automation, and Response) system via its API. It sends an HTTP PUT request to the specified SOAR API endpoint with detailed task information to modify an existing task.

Common scenarios for this node include:

  • Automating updates to security incident tasks based on workflow conditions.
  • Integrating task management within a SOAR platform into broader automation pipelines.
  • Updating task metadata such as status, priority, or attachments dynamically from other systems.

For example, after an automated investigation step completes, this node can update the corresponding task in the SOAR system with new status, description, or attachments reflecting the investigation results.

Properties

Name Meaning
Url of Soar API The full endpoint URL for the SOAR API service where the task update request will be sent.
Type Numeric type identifier of the task (e.g., 0).
Name The name/title of the task to update.
Code Unique code identifying the task.
Department Code Code representing the department associated with the task.
Case Code Code linking the task to a specific case.
Username Username of the user performing the update.
Catalog Priority Code Priority code indicating the urgency or importance of the task.
SLA Code Service Level Agreement code related to the task.
Description Textual description providing details about 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 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 update was successful.
  • response: The raw response returned by the SOAR API after the update request.
  • taskName: The name of the task that was updated.
  • error (only if failed): Error message describing why the update failed.

No binary data is produced by this node.

Example output JSON snippet:

{
  "success": true,
  "response": { /* SOAR API response object */ },
  "taskName": "Example Task"
}

Dependencies

  • Requires an API authentication token credential to authorize requests to the SOAR API.
  • The SOAR API must be accessible at the provided URL.
  • The node uses HTTP PUT requests with JSON payloads.
  • The "Accept-Language" header is set to Vietnamese ("vi") in requests.

Troubleshooting

  • Invalid URL or unreachable SOAR API: Ensure the soarUrl is correct and the SOAR API server is reachable from n8n.
  • Authentication errors: Verify that the API token credential is valid and has sufficient permissions to update tasks.
  • Malformed attachment IDs: The attachmentIds property must be a valid JSON string representing an array; invalid JSON will cause parsing errors.
  • Missing required properties: All required fields must be provided; missing any will likely cause the SOAR API to reject the request.
  • API errors: If the SOAR API returns an error, check the response for details and ensure the task exists and the data conforms to expected formats.

If the node is configured to continue on failure, errors will be included in the output JSON; otherwise, execution will stop with an error.

Links and References

  • [SOAR API Documentation] — Refer to your SOAR platform's official API docs for details on task update endpoints and payload structure.
  • n8n HTTP Request Node — For understanding how HTTP requests are made within n8n workflows.

Discussion