Setup runbook

From deploy hook
to shared release map.

DeployState is deliberately simple: map the parts of a release, paste the generated URLs into your deployment tool, and follow the run as every step settles.

Describe the release

Create a sequence, then connect its steps.

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

Create your account

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.

deploy hook

curl -X POST \
  https://your-deploystate-url/api/v1/hooks/step-token/start

/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.

Keep the companion nearby

Connect the Mac companion when it is available to you.

After the signed Mac companion is available to your workspace, sign in once to follow runs from the menu bar. The web workspace remains the shared source of truth.

DeployState Mac companionUse the menu bar icon to open the app or check its connection.

Optional

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.