Commanders Act icon

Commanders Act

Use the Commanders Act API
Join our community

Actions108

Overview

This node integrates with the Commanders Act API, specifically providing access to its Monitoring resource's "Get Notification" operation. It allows users to retrieve detailed information about a specific notification within the monitoring system of Commanders Act. This is useful for scenarios where you want to programmatically fetch the status or details of alerts and notifications related to your data collection and event monitoring setup.

Practical examples include:

  • Automatically fetching notification details when an alert triggers.
  • Integrating notification data into dashboards or reporting workflows.
  • Using notification info to trigger further automation based on monitoring events.

Properties

Name Meaning
Notification ID The unique identifier of the notification to retrieve. This is required to specify which notification's details should be fetched.
Query Parameters Optional additional parameters to refine or filter the request. These include:
- End (string)
- Fields[template] (string)
- Filter (JSON)
- Various filter subfields like begin_date, end_date, from, to, rangeType, search, segment_id, sup_filters for device/location arrays, types
- Granularity (string)
- Include (string)
- Page (JSON)
- Sort (JSON or string)
- Source (string)
- Start (string)
- Token (password string)

Output

The node outputs the JSON response returned by the Commanders Act API for the requested notification. The output structure corresponds directly to the API's notification object, which typically includes details such as notification metadata, status, timestamps, and related alert information.

If the API returns no content, the node outputs a status message indicating "204 No Content".

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Commanders Act API.
  • The node uses the base URL https://api.commander1.com/v2 for all requests.
  • Proper configuration of the API credentials in n8n is necessary before using this node.

Troubleshooting

  • Missing Notification ID: If the Notification ID property is not provided when required, the node will throw an error stating that the Notification ID is required.
  • API Credential Missing: The node will fail if the Commanders Act API credentials are not set up or missing.
  • Invalid Query Parameters: Providing malformed JSON or unsupported query parameters may cause the API call to fail.
  • API Errors: Any errors returned by the Commanders Act API will be wrapped and reported by the node with a message starting "Error calling Commanders Act API".
  • Empty Response: If the API returns an empty string, the node outputs a "204 No Content" status message.

To resolve these issues:

  • Ensure all required IDs and parameters are correctly set.
  • Verify API credentials are configured and valid.
  • Validate JSON inputs for query parameters.
  • Check network connectivity and API endpoint availability.

Links and References

Discussion