Quick Start

Get your first API test running in under 5 minutes.

Step 1: Create a Test

1. Navigate to Tests in the sidebar

2. Click New Test

3. Fill in the basics:

   • Name: A descriptive name (e.g., "Production API Health Check")
   • Method: GET (or your endpoint's method)
   • URL: Your endpoint URL (e.g., https://api.example.com/health)

4. Configure a basic assertion:

   • Type: Status Code
   • Expected: 2xx (matches any 200-level status)

5. Set the schedule:

   • Frequency: 5 minutes
   • Timeout: 30 seconds

6. Click Create Test

Step 2: Run Your Test

After creating the test, click Run Now to execute it immediately. You'll see:

• Response status code
• Response time
• Assertion results (pass/fail)

Step 3: Set Up Notifications

1. Go to Integrations → Add Integration

2. Choose your channel:

   • Slack: Paste your webhook URL
   • Email: Configure SMTP settings
   • Webhook: Enter your endpoint URL

3. Test the integration to confirm it works

Step 4: Create a Routing Rule

1. Go to Routing Rules → New Rule

2. Configure conditions:

   • Severity: Critical, High (for important alerts)
   • Or leave empty to match all issues

3. Add an action:

   • Select your integration
   • Save the rule

You're Done!

Your API is now being monitored. When something breaks:

1. Pingward detects the failure
2. An issue is created (or an existing one is updated)
3. Alerts are sent through your routing rules
4. You get notified and can investigate

Next Steps

• Add more tests for your critical endpoints
• Configure assertions for deeper validation
• Set up a status page for customers
• Learn about importance levels to control severity