OrbitsDocs
esc
    Open Orbits
    Team and accountNotifications

    Notifications

    Choose which events reach your team by email and Slack, see what needs you in the bell, and get a weekly summary every Monday. Microsoft Teams and webhooks pick their own events.

    Where notifications go

    WhereWhat decides it
    EmailThe team's switches in Settings › Notifications
    SlackThe Slack switch for each event in Settings › Notifications, and the channel the Slack page picks for it
    Microsoft TeamsThe events picked when Teams was installed
    WebhooksThe events picked when the webhook was added
    The bellAlways on, for everyone in the team

    Alerts are separate: each alert rule says itself whether it emails the team or calls the alert webhook.

    The team's switches

    Go to Team › Settings › Notifications. Each event has an Email switch and a Slack switch. Owners and admins change them; changes save as you make them.

    EventWhenEmail by defaultSlack by default
    A deploy failsA production or preview build failsOnOn
    A production deploy goes liveAfter every promote or push to the production branch, once it serves the siteOffOn
    A domain or certificate needs attentionA domain's DNS stops pointing at Orbits, a certificate can't be issued, or one within 14 days of expiring hasn't renewedOnOn
    Someone joins the teamIncluding people who accepted an invite. Nobody is told about themselves joiningOnOff
    Weekly summaryMondays at 9:00, Lagos timeOnOff

    Slack switches only matter once Slack is connected. A failed deploy's email says why it failed and on which branch. A domain that's still not set up an hour after it was added also gets its own "DNS needed" email, to whoever added it; the domain switch turns that off too.

    Who gets the emails

    Team email goes to everyone who can deploy: owners, admins and members. Viewers don't get team email. The "DNS needed" email goes only to the person who added the domain.

    There is no per-person opt-out yet: the switches are for the whole team.

    The weekly summary

    Every Monday at 9:00 Lagos time, for the past Monday to Sunday across all the team's projects:

    • Visitors per day and top pages, from Analytics;
    • Deploys and the average build time;
    • Mobile Web Vitals from the busiest project with Speed Insights.

    Analytics and Speed Insights figures appear only for projects that have them, which needs Pro. When the Slack switch is on, a short version (visitors, deploys, build time) is posted in the channel picked for "promoted to production", or another channel the Slack page has. Microsoft Teams and webhooks don't get the weekly summary.

    The bell

    The bell in the top bar shows what's worth a look in the current team, newest first:

    Notification
    A deploy failedWith the reason and the branch, such as "Missing module 'mdsvex' · main"
    A domain is liveIt has its certificate and serves over HTTPS
    A domain stopped pointing at OrbitsCheck its DNS record
    A certificate couldn't be issued, or isn't renewing
    Someone joinedWith who invited them, such as "Invited by Tunde". Not your own joining
    An alert fired

    A dot on the bell means there are notifications you haven't read, and the list says how many are new. Opening one takes you to its page. Mark all as read clears them, for you only; everyone has their own read state.

    The bell goes back 30 days, and no further than when you joined the team. Everything else that happens is on the activity feed.

    From the API

    Call
    GET /v1/teams/{team}The team, with notifications: each event's email and slack switch
    PATCH /v1/teams/{team}Change switches. Send only what changes: {"notifications": {"deploy.live": {"email": true}}}
    GET /v1/teams/{team}/notificationsThe bell's list, with unread_count; unread=true for unread only
    POST /v1/teams/{team}/notificationsMark read: {"ids": [...]} or {"all": true}

    The events are named deploy.failed, deploy.live, domain.attention, member.joined and weekly. See API › Teams.

    Was this page helpful?

    Updated