Quick Start Guide

2. Create your first status page

Navigate to Status Pages in the sidebar and click Create Page. Fill in the following fields:

• Name — A human-readable label, e.g. Acme Cloud.
• Slug — URL-safe identifier used in the public URL. Auto-generated from the name but editable.
• Timezone — All incident timestamps on the public page display in this timezone.
• Public — Toggle on to make the page visible without authentication.

Equivalent API call:

# Create a status page via the API
curl -X POST https://usebeacon.pro/api/v1/pages \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "Acme Cloud",
    "slug": "acme-cloud",
    "timezone": "America/New_York",
    "is_public": true
  }'

3. Add components

Components represent the individual services or pieces of infrastructure your users depend on. Common examples:

• API — Your REST or GraphQL endpoint.
• Dashboard — The web application your customers log in to.
• Workers — Background job processors, queues, or scheduled tasks.

Open your new status page, go to the Components tab, and click Add Component. Each component starts in the operational state.

# Add a component
curl -X POST https://usebeacon.pro/api/v1/pages/acme-cloud/components \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "API",
    "description": "Core REST API",
    "status": "operational"
  }'

4. Create an incident

When something goes wrong, create an incident to communicate the issue. In the dashboard, click New Incident and fill in:

• Title — Short, specific summary, e.g. Elevated API error rates.
• Impact — One of none, minor, major, or critical.
• State — Usually starts at investigating.
• Initial update — A message describing what you know so far.

# Create an incident
curl -X POST https://usebeacon.pro/api/v1/pages/acme-cloud/incidents \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "title": "Elevated API error rates",
    "impact": "major",
    "state": "investigating",
    "message": "We are seeing increased 5xx responses from the API. The team is investigating."
  }'

5. Post an incident update

As your team learns more, post updates to keep users informed. Open the incident and click Add Update. Each update appears as a timestamped entry in the incident timeline.

# Post an update to an incident
curl -X POST https://usebeacon.pro/api/v1/incidents/{incidentId}/updates \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "message": "Root cause identified: a misconfigured load balancer rule. Rolling back the change now."
  }'

6. Resolve the incident

Once the issue is fixed, update the incident state to resolved. This moves the incident out of the active section on the public page and notifies subscribers that the issue is over.

# Resolve the incident
curl -X PATCH https://usebeacon.pro/api/v1/incidents/{incidentId} \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "state": "resolved",
    "resolved": true
  }'

7. View your public status page

Your status page is live at:

https://usebeacon.pro/status/{workspace-slug}/{page-slug}

Share this URL with your users or set up a custom domain. The page shows a real-time view of all component statuses, active incidents, and recent incident history.

8. Next steps

Now that your status page is live, explore these features to get the most out of Beacon:

• Uptime Monitors — Set up HTTP checks and heartbeats to automatically detect outages and create incidents.
• Embeddable Widget — Add a floating status badge to your app with a single script tag.
• API Tokens — Generate tokens for CI/CD pipelines, deployment scripts, or custom integrations.
• Subscriber Notifications — Let your users subscribe to email notifications for incidents on your page.