How-To Guides

Step-by-step guides for common tasks in SupaGuard.

Checks

How to Create a Scheduled Check

1. Go to Checks → Create Check
2. Enter a name for your check
3. Write your Playwright test
4. Set the schedule using cron syntax or presets:
   • Every 5 minutes
   • Every 15 minutes
   • Every hour
   • Daily
5. Select run locations
6. Click Create

How to Pause a Check

1. Go to Checks
2. Find the check you want to pause
3. Click the ⋮ menu
4. Select Disable

To resume, repeat the steps and select Enable.

How to View Check Results

1. Go to Checks
2. Click on a check name
3. View the results timeline
4. Click a result to see details:
   • Screenshot
   • Trace file
   • Logs
   • Network requests

---

Organizations

How to Invite Team Members

1. Go to Settings → Team
2. Click Invite Member
3. Enter their email address
4. Select their role (Admin, Member, Viewer)
5. Click Send Invite

How to Create API Keys

1. Go to Settings → API Keys
2. Click Create Key
3. Enter a description
4. Set permissions
5. Copy the key (it won't be shown again)

---

Alerts

How to Mute Alerts Temporarily

1. Go to Checks
2. Find the check
3. Click ⋮ → Mute Alerts
4. Set the duration (1 hour, 24 hours, custom)
5. Click Mute

How to Create an Escalation Policy

1. Create primary alert policy (e.g., Slack)
2. Create secondary policy (e.g., PagerDuty)
3. Set the secondary with a delay (e.g., after 15 minutes)
4. Link both to the same check

---

Troubleshooting

Check is Failing Unexpectedly

1. View the trace - See exactly what happened
2. Check selectors - Elements may have changed
3. Review timing - Add explicit waits if needed
4. Test locally - Run the script on your machine

Not Receiving Alerts

1. Check channel configuration
2. Send a test notification
3. Verify email isn't in spam
4. Check webhook logs for errors