Notifications
Send a message to a chat or push service when Release Ops creates a ticket, supersedes one, or hits an error while polling.
Prerequisites
Section titled “Prerequisites”- You are signed in to Release Ops.
- You have a Shoutrrr URL for the service you want to notify. Shoutrrr is the library Release Ops uses to send messages. It supports services such as Slack and ntfy, for example
slack://token@channelorntfy://topic.
Add a notification target
Section titled “Add a notification target”- Open Notifications and click Add notification target.
- Enter a Name, for example
Slack - releases. - Enter the Shoutrrr URL. The field hides what you type, because the URL usually contains a secret.
- Under Events, select the poll events you want to hear about: Create, Error and Supersede. All three are selected by default.
- Keep Enabled on.
- Click Save.
- Back in the list, click the Test notification icon in the Actions column to check the target.
Result: The target appears in the list with a Configured badge in the URL column. Release Ops stores the URL encrypted and never shows it again.
Test a target
Section titled “Test a target”- Click the Test notification icon in the Actions column. You can also click Test notification at the bottom of the edit panel.
- Wait for the message in the bottom-right corner of the page.
Result: Test notification sent means the service accepted a test message. Test notification failed means Shoutrrr could not deliver it. The test uses the saved URL, so save your changes first.
Edit a target
Section titled “Edit a target”- Click the Edit icon in the Actions column.
- Change the name, the events or the Enabled switch.
- To replace the URL, enter the new one. Leave the field blank to keep the existing URL.
- Click Save.
Pause a target
Section titled “Pause a target”Switch Enabled off in the edit panel and click Save. Release Ops skips disabled targets. The list shows Disabled in the Enabled column.
Delete a target
Section titled “Delete a target”- Click the Delete icon in the Actions column.
- Click Delete to confirm.
What gets sent
Section titled “What gets sent”| Event | Sent when |
|---|---|
| Create | A ticket is created for a new release. |
| Supersede | An older open ticket is superseded by a new one. |
| Error | A repo could not be polled, or its ticket could not be created or updated. |
Release Ops does not send a message for a baseline, a skipped poll, a merge or a skipped release because a ticket is still open.
Every enabled target that subscribes to the event gets the message. If you select notification targets on a repo, only those targets get that repo’s messages. A message that cannot be delivered does not stop the poll.
Field reference
Section titled “Field reference”| Field | Description | Required |
|---|---|---|
| Name | A display name for the list and the repo form. | Yes |
| Shoutrrr URL | Where messages go. Stored encrypted and not shown again. | Yes |
| Events | Create, Error and Supersede. Select at least one. | Yes |
| Enabled | Disabled targets receive no messages. | No |
The list shows Name, Events, Enabled, URL and Actions.
Troubleshooting
Section titled “Troubleshooting”Test notification failed
Section titled “Test notification failed”The service did not accept the message. Check the Shoutrrr URL against the service’s format and make sure the token and channel or topic are valid. Enter the corrected URL and save before you test again.
A repo sends no messages
Section titled “A repo sends no messages”Check that the target is enabled and subscribes to the event. If the repo has specific notification targets selected, only those receive its messages. Edit the repo to check the selection.
I get no message for the first poll of a repo
Section titled “I get no message for the first poll of a repo”That is expected. The first poll records a baseline and creates no ticket, so there is nothing to announce. See How release detection works.