Skip to content
My Beast
Cart
Developer docsMenu

Status · Getting started

Status

Status calls your sites and APIs, and waits for your jobs to check in. When one stops answering, your team hears it within a minute, and your customers can see it on a status page.

It's for anyone who runs a site, an API or scheduled jobs and wants to know about an outage before a customer writes in. Nothing is installed: an HTTP check needs a public address, and a heartbeat needs one HTTPS request from your job.

How it works

Status has two kinds of monitor:

  • An HTTP check calls an address as often as every 30 seconds, as your plan allows, and reads the answer. Two failed checks in a row, 15 seconds apart, and it's down. One good answer and it's up again.
  • A heartbeat is an address your job calls each time it runs. When the call doesn't come in time, or the job says it failed, the heartbeat is down.

When a monitor goes down, or comes back up, Status tells people:

  • When the project's Incidents is connected, it opens an incident there, and resolves it on recovery.
  • Otherwise, or when Incidents doesn't take it, it tells the alert channels: email to everyone who may open the project, and a Telegram chat and a Slack channel when you set them.
  • Either way, your own code hears it through signed webhooks.

The monitors you mark public show on the project's status page, with their names, states and the last 90 days, never their addresses. Maintenance windows keep planned work quiet, and a deploy can tell Status when it went live.

Where things are:

  • You buy Status for a project at id.my-beast.com, where the project's people and their roles are kept too. Status's page lists the plans.
  • The project's Status pages are at https://services.my-beast.com/<workspace>/<project>/status: an overview, HTTP checks, Heartbeats, Maintenance and Settings.
  • Pings and the API are at https://services.my-beast.com/status, for your servers and jobs.

What you need

  • A My Beast project with a Status plan.
  • For an HTTP check, an address Status can reach from the internet. Laravel answers /up out of the box.
  • For a heartbeat, a job or cron that can make an HTTPS request, such as with curl.
  • To change who is told or to make keys, the admin role in the project. Editors add and change monitors; viewers see them.

Explore the docs

QuickstartFrom a new project to your first monitor and alert.Check a site or an APIWhat is checked, and what counts as down.Watch a cron jobPing a heartbeat from a crontab or Laravel's scheduler.Choose who's toldEmail, Telegram, Slack and Incidents, and when each hears.Receive webhooksEvents, payloads, signatures and retries.Share a status pageWhat your customers see, its feed and its badge.Tell Status about deploysMark deploys and keep monitors in code.APIThe ping, every endpoint and the webhook messages.