Setup runbook

From deploy hook
to desktop signal.

DeployState is deliberately simple: map the parts of a release, paste the generated URLs into your deploy tool, and let the desktop app follow the run.

01

Describe the release

Create a sequence, then add its branches.

Start with the work your team actually waits for. A simple production deploy might branch into a web app, queues, workers, and analytics. Each item is a step with its own webhook URL.

Create your account
02

Use the private endpoint

Paste a webhook where your deploy tool can call it.

Open a step in DeployState and copy its URL. Append the action that represents the event. This is the fastest setup and works in tools that only allow a text-only URL, including Laravel Forge.

/start opens a run/complete marks it ready/fail surfaces a problem

Optional Name the sequence and step for a readable URL, then send the same private step token as X-DeployState-Key: curl -X POST -H "X-DeployState-Key: step-token" https://your-deploystate-url/api/v1/production/deploy/start. The full API reference explains both formats and optional response details.

03

Keep the companion nearby

Sign in to the desktop app once.

DeployState lives in the menu bar after you sign in. It stays out of the way until a run begins, then opens a compact update in the upper-right corner of your screen.

DeployState DesktopUse the menu bar icon to open the app or check its connection.
Connected
04

Make the first signal

Trigger a real release—or simulate one.

Once the URLs are in place, your next deploy will appear automatically. In local development, you can use the simulator to walk a saved sequence through its steps.

$ php artisan sequence:simulate --sequence=your-sequence-id

First run

Five minutes to a signal you can trust.

Get started with 1 free sequence today. No credit card, no trial clock.

Start free