Skip to content

GoAlert Notifications

Overview

GoAlert is a self-hosted on-call scheduling and alerting platform. Apprise raises alerts through a GoAlert Generic API integration key:

  1. Sign in to GoAlert and open the Service that should receive the alerts.
  2. Under Integration Keys, click the + button.
  3. Give the key a name such as Apprise, set the type to Generic API and save it.
  4. Copy the generated URL. It looks like https://goalert.example.com/api/v2/generic/incoming?token=ab12cd34-ab12-4c5d-8e9f-0123456789ab.

The token value at the end is your integration key, and the start of the URL is your GoAlert server. For the example above, the Apprise URL is goalerts://goalert.example.com/ab12cd34-ab12-4c5d-8e9f-0123456789ab.

Each integration key belongs to one GoAlert service. Add more keys to the same URL to raise the alert in several services at once.

Valid syntax is as follows:

  • goalert://{hostname}/{integration_key}
  • goalerts://{hostname}/{integration_key}
  • goalerts://{hostname}:{port}/{integration_key}
  • goalerts://{hostname}/{path}/{integration_key}
  • goalerts://{hostname}/{integration_key1}/{integration_key2}/{integration_keyN}

Use goalerts:// for secure (https) connections and goalert:// for insecure (http) ones.

Variable Required Description
hostname Yes The GoAlert server you are sending your alert to.
integration_key Yes One or more GoAlert Generic API integration keys. Each key raises the alert in the service it belongs to.
port No The port the GoAlert server is listening on. The default is 80 for goalert:// and 443 for goalerts://.
path No If GoAlert is hosted under a sub-path (for example behind a reverse proxy), include it before your integration keys. The default is /.
action No What to do with the alert. Possible values are map, trigger and close. map closes matching alerts when the notification type is success and raises an alert for every other type. trigger always raises an alert and close always closes matching alerts. The default is map.
dedup No A deduplication key. Alerts sent with the same key update the same open alert instead of creating a new one, and a close action closes it. Without it, GoAlert only matches alerts with the exact same title and body, so set a dedup key whenever you want a later message to close an alert.

You can also attach extra metadata to an alert by adding +key=value entries to the URL, for example +env=prod&+team=ops.

The title becomes the alert summary, which GoAlert sends by SMS and voice. The body becomes the alert details. When no title is given, the start of the body is used as the summary. GoAlert does not accept file attachments on this API.

Variable Description
overflow Controls messages that exceed a service’s documented limit. The default is upstream.
👉 upstream: Send one message without splitting or truncating it for that limit.
👉 truncate: Keep the portion that fits and discard the rest.
👉 split: Prefer a readable break, fall back to a hard boundary, and send every part in order.
Splitting undeclared or structured content is best effort. Use upstream when the body must remain one intact document.
format This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verify External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes.
redirect By default, Apprise will follow HTTP redirects (3xx responses) issued by the remote server, matching the behaviour of the underlying requests library. If you want to prevent custom headers and credentials from being forwarded to destinations that differ from the original URL, set this to no. By default it is set to yes.
cto This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rto This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojis Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no.
Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tz Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area.
retry The number of additional delivery attempts to make after the first failure before giving up. Accepts an integer in the range 0 to 10. The default is 0 (no retries – a single attempt is made). When combined with wait, Apprise pauses the specified number of seconds between each attempt.
wait The number of seconds to pause between retry attempts. Accepts a decimal value in the range 0.0 to 20.0; integer values are promoted to float automatically. The default is 0.5. This value is only meaningful when retry is greater than zero – a service with retry=0 makes exactly one attempt regardless of the wait value.
optional When set to yes, a delivery failure for this service is silently absorbed. The overall notify() call still evaluates as true even if this endpoint was unreachable, provided that every required (non-optional) service in the same batch succeeded. Setting this flag does not skip delivery or bypass retry logic – all configured retry attempts are still made before the failure is absorbed. By default this is set to no, meaning every failure is propagated to the caller.

Raise a GoAlert alert:

Terminal window
# Assuming our {hostname} is goalert.example.com
# Assuming our {integration_key} is ab12cd34-ab12-4c5d-8e9f-0123456789ab
apprise -vv -t "Disk space low" -b "Only 2% free on /var" \
"goalerts://goalert.example.com/ab12cd34-ab12-4c5d-8e9f-0123456789ab"

Raise an alert with a deduplication key, then close it once the problem is fixed:

Terminal window
# Raise the alert
apprise -vv -n failure -t "Disk space low" -b "Only 2% free on /var" \
"goalerts://goalert.example.com/ab12cd34-ab12-4c5d-8e9f-0123456789ab?dedup=disk-var"
# Close it again (a success notification closes alerts by default)
apprise -vv -n success -t "Disk space recovered" -b "40% free on /var" \
"goalerts://goalert.example.com/ab12cd34-ab12-4c5d-8e9f-0123456789ab?dedup=disk-var"

Raise the same alert in two services, with some metadata attached:

Terminal window
apprise -vv -t "Backup failed" -b "Nightly backup did not finish" \
"goalerts://goalert.example.com/ab12cd34-ab12-4c5d-8e9f-0123456789ab/cd34ef56-cd34-4e5f-9a0b-0123456789cd?+env=prod"
Questions or Feedback?

Documentation

Notice a typo or an error?

Technical Issues

Having trouble with the code? Open an issue on GitHub:

Made with love from Canada