Create Case Soar icon

Create Case Soar

Create case in Soar
Join our community

Overview

This node, named "Create Case Soar," is designed to create a case record in a Soar API service. It sends detailed case information to the specified Soar API endpoint, facilitating automated case creation workflows. This node is beneficial in scenarios where incident or case management needs to be integrated into an automation pipeline, such as automatically logging security incidents, customer support tickets, or operational cases based on incoming data.

Practical examples include:

  • Automatically creating a security incident case in a Soar platform when suspicious activity is detected.
  • Logging customer support cases with detailed metadata from form submissions or monitoring tools.
  • Creating operational cases for IT or business processes triggered by external events.

Properties

Name Meaning
Url of Soar API The endpoint URL for the Soar API service where the case will be created.
Name of Case The name/title of the case to be created.
Catalog Type Code The catalog type code categorizing the case.
Customer Code The customer identifier associated with the case.
Department Code The department responsible or related to the case.
User Name Username of the user who is creating the case.
Case Code Unique code for the case; can be dynamically set from input JSON data.
Catalog Danger Level Code Danger level classification code for the case catalog.
SLA Code Service Level Agreement code applicable to the case.
Catalog Resolution Code Resolution code for the case catalog.
Description Textual description providing details about the case.
Date Detection Date and time when the case was detected.
Date Occurrence Date and time when the case actually occurred.
Attachment IDs Array of attachment IDs linked to the case (provided as a JSON string).
Type Numeric type identifier for the case (default example value is 2).
Options Numeric options flag for additional case settings (default is 0).
More Information Additional textual information about the case.
Tenancy Code Tenancy code related to the case context or environment.

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 case creation succeeded.
  • response: The full response returned by the Soar API after creating the case.
  • caseName: The name of the case that was attempted to be created.
  • error (only if failure): Error message describing why the case creation failed.

No binary data is output by this node.

Dependencies

  • Requires access to a Soar API service endpoint.
  • Needs an API authentication token credential configured in n8n (referred generically as an API key credential).
  • The node uses HTTP POST requests to communicate with the Soar API.
  • The "Accept-Language" header is set to Vietnamese ("vi") in requests, which may affect localization.

Troubleshooting

  • Common issues:

    • Invalid or missing API endpoint URL will cause request failures.
    • Incorrect or expired API authentication token will result in authorization errors.
    • Malformed JSON in the "Attachment IDs" property can cause parsing errors.
    • Required fields missing or empty may lead to validation errors from the API.

  • Error messages:

    • Errors thrown during HTTP requests are logged and either cause the node to fail or continue based on the "Continue On Fail" setting.
    • Typical error messages include network errors, unauthorized access, or validation failures from the Soar API.

  • Resolutions:

    • Verify the Soar API URL and ensure it is reachable.
    • Confirm the API token credential is valid and has necessary permissions.
    • Ensure all required properties are correctly filled.
    • Validate that "Attachment IDs" is a properly formatted JSON array string.

Links and References

Discussion