Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions83

Overview

This node integrates with the Commanders Act API, specifically enabling users to update monitoring notifications. It allows updating existing notification configurations related to alerts and monitoring within the Commanders Act platform. This is useful for automating changes to notification settings based on dynamic workflows or external triggers.

Practical examples include:

  • Automatically modifying alert notification parameters when certain conditions in your data change.
  • Updating notification details such as filters or thresholds without manual intervention.
  • Integrating notification updates into broader automation pipelines that manage monitoring and alerting.

Properties

Name Meaning
Notification ID The unique identifier of the notification to update. Required for update operations on monitoring notifications.
Query Parameters Optional additional query parameters to refine or filter the request. Includes options like date ranges (start, end), filtering criteria (filter and its subfields), pagination (page), sorting (sort), and others.
Request Body JSON object containing the data to update the notification with. This includes any fields supported by the Commanders Act API for notification updates.

Details on Query Parameters Options (selected):

  • End: End date/time for filtering.
  • Fields[template]: Template fields selection.
  • Filter: JSON filter object or specific filter fields like begin_date, end_date, search, segment_id, etc.
  • Granularity: Level of detail for returned data.
  • Include: Additional related data to include.
  • Page: Pagination details.
  • Sort: Sorting instructions.
  • Source: Source identifier.
  • Start: Start date/time for filtering.
  • Token: An optional token, treated as a password field.

Output

The node outputs an array of JSON objects representing the response from the Commanders Act API after attempting to update the notification. The structure depends on the API's response but typically includes updated notification details or status information.

If the API returns no content (HTTP 204), the output will contain a JSON object indicating "204 No Content".

No binary data output is produced by 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.
  • Proper configuration of credentials in n8n is necessary to authenticate requests.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node throws an error indicating missing credentials. Ensure the API key is configured correctly.
  • Required Parameter Missing: If the Notification ID is not provided for update operations, the node throws an error specifying that the Notification ID is required.
  • API Errors: Any errors returned by the Commanders Act API are wrapped and presented with the message "Error calling Commanders Act API" along with the original error message and stack trace if available.
  • Invalid JSON in Request Body: The request body must be valid JSON; otherwise, parsing errors may occur.
  • Unexpected Response Format: If the API returns a string response that cannot be parsed as JSON, the raw text is returned instead.

To resolve issues:

  • Verify all required input properties are provided.
  • Check API credentials and permissions.
  • Validate JSON syntax in the request body.
  • Review API documentation for correct usage of query parameters and request body fields.

Links and References

Discussion