Apprise icon

Apprise

Send notifications through an Apprise API instance

Apprise

AI-generated

Overview

The Apprise node sends notifications through an Apprise API instance. It allows you to configure the notification's title, body, type (info, success, warning, failure), and target recipients either by specifying URLs directly or by referencing a persistent store key. This node is useful for integrating n8n workflows with various notification services supported by Apprise, such as email, SMS, push notifications, and more.

Common scenarios:

  • Sending alerts to multiple channels when a workflow event occurs.
  • Notifying users of workflow results or errors.
  • Broadcasting status updates to teams via different notification platforms.

Practical example:
You can use this node to send a "Success" notification to Slack and email whenever a data import completes successfully in your workflow.

Properties

Name Type Meaning
Title String The title of the notification.
Body String The main content/body of the notification. (Required)
Type Options The type/category of the notification: Info, Success, Warning, or Failure.
Use Key? Boolean Whether to use a persistent store key instead of direct URLs for notification delivery.
URLs String A comma or space-separated list of URLs to send the notification to. (Required unless using key)
Key String The configuration key used if "Use Key?" is enabled. (Required if using key)
Tag String Comma-separated list of tags to filter or categorize notifications. (Visible if using key)

Output

  • The node returns the input items unchanged on success.
  • If an error occurs and "Continue On Fail" is enabled, the output will include:
    • The original json input.
    • An error field containing the error details.
    • A pairedItem field indicating the index of the failed item.

Example error output:

{
  "json": { /* original input */ },
  "error": { /* error object */ },
  "pairedItem": 0
}

Dependencies

  • External Service: Requires access to an Apprise API instance.
  • Credentials: Needs an n8n credential named appriseApi with at least a domain property specifying the Apprise API endpoint.
  • Network: The n8n instance must be able to reach the Apprise API server.

Troubleshooting

Common issues:

  • Missing or invalid credentials: Ensure the appriseApi credential is configured correctly with the correct domain.
  • Incorrect URLs or Key: If neither URLs nor a valid key are provided, the notification will not be sent.
  • API unreachable: Network/firewall issues may prevent n8n from reaching the Apprise API endpoint.
  • Invalid notification type: Only the specified types ("info", "success", "warning", "failure") are accepted.

Error messages:

  • "Cannot read properties of undefined (reading 'domain')": The Apprise API credential is missing or misconfigured.
  • "Request failed with status code ...": The Apprise API endpoint returned an error; check the endpoint and payload.
  • "Missing required parameter: body": The Body property is required and must not be empty.

How to resolve:

  • Double-check credential setup in n8n.
  • Verify that the Apprise API endpoint is accessible from your n8n instance.
  • Ensure all required fields are filled out according to your chosen configuration (URLs or Key).

Links and References

Discussion