Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions108

Monitoring → Update Notification

AI-generated

Overview

This node interacts with the Commanders Act API to update a monitoring notification. It is useful for users who want to modify existing notifications related to monitoring alerts within the Commanders Act platform. For example, a user can update the details or settings of a specific notification by providing the notification ID and the updated data in the request body.

Use Case Examples

  1. Updating the message or recipients of a monitoring notification to ensure the right stakeholders are informed about specific alerts.
  2. Modifying notification settings to change how and when alerts are sent.

Properties

Name Meaning
Notification ID The unique identifier of the notification to update. Required to specify which notification to modify.
Query Parameters Optional query parameters to refine or control the API request behavior, such as filtering or pagination options.
Request Body The JSON object containing the updated notification data to be sent in the PATCH request body.

Output

JSON

  • id - The unique identifier of the updated notification.
  • alertId - The ID of the alert associated with the notification.
  • name - The name of the notification.
  • description - Description of the notification.
  • enabled - Boolean indicating if the notification is enabled.
  • createdAt - Timestamp when the notification was created.
  • updatedAt - Timestamp when the notification was last updated.

Dependencies

  • Commanders Act API
  • An API authentication token (Bearer token)

Troubleshooting

  • Ensure the Notification ID is provided; otherwise, the node will throw an error indicating the missing Notification ID.
  • Verify that the API credentials (site ID and token) are correctly set and valid to avoid authentication errors.
  • Check the structure and validity of the JSON in the Request Body to prevent request failures.
  • If the API returns an error, review the error message for details and adjust the input parameters accordingly.

Links

Discussion