Getting Started

This guide walks through the smallest useful StackPulse setup: one app, one service, one check, and one notification path.

Create an app

An app is the top-level system you want to monitor. Use the production name your team already recognizes.

1. Open StackPulse.
2. Choose Add app.
3. Enter the app name.
4. Select the environment, such as production.
5. Save the app.

Use separate apps when ownership, incident handling, or deployment cadence differs.

Add a service

A service represents one component inside the app.

Common service types:

• frontend for websites and client apps.
• api for backend APIs.
• database for database-backed health endpoints or provider REST checks.
• worker for queues and background jobs.
• auth for identity services.

Choose the type that best describes the component, not just the protocol used by the check.

Add a check

A check is the actual probe StackPulse runs.

For a first check, use a simple public endpoint:

Method: GET
URL: https://example.com/health
Expected status: 200
Timeout: 5000 ms

Keep first checks boring. Once the basic path works, add more specific checks for APIs, databases, or authenticated endpoints.

Configure alerts

Open Settings and configure alert delivery for the environment you care about.

StackPulse supports:

• Email recipients.
• Discord webhooks.
• Resolution notifications when incidents recover.

Start with one destination. Add more only when they map to a real response workflow.

Trigger a test

Use the controlled incident test in Settings to verify delivery.

The test confirms:

• StackPulse can create an incident.
• Notification destinations are configured.
• Delivery history records the outcome.
• Resolution notifications work when enabled.