Getting Started with onduty.sh

Welcome to onduty.sh! We've designed this platform to be the simplest, most effective way for your team to manage on-call rotations and critical alerts.

This guide will walk you through setting up your account and getting your first alert flowing in minutes.


1. Create Your Team

When you first sign up, you'll be prompted to create an Organization. This is the home for your team, your services, and your schedules.

  • Tip: Use your company name (e.g., "Acme Corp Engineering").
  • You can invite unlimited team members later.

2. Add Your First Service

A Service represents something you want to monitor, like your API, Database, or a specific background worker.

  1. Navigate to Services in the dashboard.
  2. Click New Service.
  3. Give it a name (e.g., Production API).
  4. This will generate an Integration Key. Keep this safe! You'll need it to send alerts.

3. Set Up a Schedule

Who should be woken up when the Production API goes down?

  1. Go to Schedules.
  2. Create a new Schedule (e.g., Backend On-Call).
  3. Add users to the rotation. You can set up:
    • Daily rotations: Switches every day at a specific time.
    • Weekly rotations: Good for larger teams.
    • Custom layers: For advanced patterns.

4. Connect Service to Schedule (Escalation Policy)

Now, link the Service to the Schedule using an Escalation Policy.

  1. Go to Escalation Policies.
  2. Create a policy named API Escalation.
  3. Step 1: Notify Backend On-Call (the schedule you just made).
  4. Step 2 (Optional): If no acknowledgement after 15 mins, notify Manager.

Finally, edit your Service and attach this Escalation Policy to it.

5. Send Your First Alert

Now for the fun part. Let's trigger a test alert to make sure everything is wiring correctly.

Open your terminal and run:

bash
curl -X POST https://onduty.sh/events/webhook/[YOUR-INTEGRATION-KEY] \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Test Alert - CPU High",
    "description": "CPU usage is at 99% on server-01",
    "severity": "critical"
  }'

If everything is set up right, your phone should start ringing (or buzzing) within seconds!


Next Steps