Skip to content

Verify

Overview

The verify command checks the validity of a notification service URL.

Usage

Verify Command Syntax
shoutrrr verify [FLAGS] [URL]
Flag Description
-h, --help Displays help for the verify command.
-u, --url stringArray Specifies the notification service URL to verify.

Note

Exactly one URL is required. It can be given with --url, as a positional argument, or with the SHOUTRRR_URL environment variable. Giving it both with --url and as an argument is an error, and either takes precedence over the environment variable. The command validates the URL format and service configuration, reporting errors for issues like unknown services or invalid URL formats.

URL

  • Specifies the service URL to validate. The URL is parsed to identify the service, and its configuration is checked for correctness.

Examples

Verify a Valid Discord URL

Example

Verify Discord URL
shoutrrr verify --url "discord://abc123@123456789"
Expected Output
Token: abc123
WebhookID: 123456789

Verify an Invalid URL

Example

Verify Invalid URL
shoutrrr verify --url "invalid://abc123"
Expected Output
error verifying URL: service not recognized

Verify a Malformed URL

Example

Verify Malformed URL
shoutrrr verify --url "discord://"
Expected Output
error verifying URL: invalid URL format