Skip to content
Install

Set up notifications

Notifications send Orchard events, such as a failed deploy or a crashing database, to the places your team already reads. You set them up in two parts: a destination sets where a message goes, and a rule sets which events reach that destination. Because the two are separate, one destination can serve several rules.

  • The Owner or Admin role in the organization, to manage organization destinations.
  • On an instance that uses PostHog, the Notifications beta turned on for your account. Go to Account settings > Early access.
  1. Go to Organization settings > Notifications.
  2. Select Add destination.
  3. In Send to, select Discord, Slack, Webhook, or Email.
  4. In Name, enter a name, such as #deploys.
  5. Enter the Webhook URL, or for email, the Recipients. Recipients must be members of the organization.
  6. Select Add destination.
  7. For a webhook, copy the signing secret. Orchard does not show it again.

To check the destination, select Send a test notification on its row.

Orchard validates webhook URLs before it saves them. It rejects internal addresses.

  1. Go to Organization settings > Notifications.
  2. In Rules, select Add rule.
  3. In Channel, select a destination.
  4. Select the events to send.
  5. Select Add rule.

Orchard recommends that you start with failure events, such as deploy.failed, pod.crashing, and backup.failed.

To route an app’s events somewhere else, add a channel on the app. You can also mute an inherited organization rule for that app.

  1. Open the app.
  2. Go to Settings > Notifications.
  3. In Team channels, select Add channel.
  4. Enter the channel details.
  5. Select the events.

To mute a rule, select Mute here on its row.

CategoryEvents
Deploysdeploy.succeeded, deploy.failed, deploy.regressed
App and database healthpod.crashing, pod.recovered, alert.firing, alert.resolved, db.crashing, db.recovered, db.storage_pressure, db.storage_recovered, db.read_only, db.writes_resumed, db.memory_raised
Backups and archivingbackup.completed, backup.failed, db.archiving_failing, db.archiving_recovered, db.restore_test_failed
Jobsjob.succeeded, job.failed
Securitysecurity.signed_in, security.app_authorized

Your own notifications are separate from organization rules. To choose which categories reach you, go to Account settings > Notifications.

Orchard records each delivery attempt and its outcome. The status appears on the destination’s row. To list deliveries from the CLI, run orchard notify deliveries <channelId>.

To resend events after you fix a destination, open the destination’s menu and select Replay the last 24 hours.