Notifications (Gotify and webhooks)

Aurral can send a notification when a flow download completes. It can also send one when daily recommendations are ready, when a user requests an album, and when that album becomes available.

Two delivery methods are available. You can use one or both.

Gotify

Gotify is a self-hosted push notification server. Configure it in Settings > Connect.

Enter these values:

• Server URL: the base URL Aurral can reach (for example, http://gotify:8888 in Docker)
• App token: the token for a Gotify application

Toggle which events fire:

• Notify when discovery updates: sends a notification when the daily recommendation refresh finishes
• Notify when weekly flow finishes: sends a notification with the number of completed and failed tracks
• Notify when a request is made: sends a notification when a user requests an album
• Notify when a request is available: sends a notification when a requested album is downloaded or already on disk

Select Test notification on the Gotify card to test the connection.

Webhooks

Webhooks send an HTTP request for each enabled event. Configure them in the Webhooks section under Settings > Connect.

Enter these values for each webhook:

• URL: the endpoint to call (must start with http:// or https://)
• Body: optional JSON data. Use these placeholders:
  • $flowName: playlist display name
  • $flowPath: on-disk playlist track folder under aurral-weekly-flow (not the _playlists M3U folder)
  • $albumName, $artistName, $username, $userId, and $event for request events
• Headers: optional key-value pairs

Leave Body blank to send a GET request. Enter a body to send a POST request.

Toggle which events fire for your webhooks:

• Notify when discovery updates
• Notify when weekly flow finishes
• Notify when a request is made
• Notify when a request is available

Aurral does not send events that you turn off, even if you configured webhook URLs.