Deploy Events
Deploy Events let you subscribe to notifications when a deployment moves through its lifecycle on Storefront Hosting. They give you a reliable signal for post-deploy automation, so your systems can react to deployment activity without polling the SCAYLE Panel or scraping application logs.
Deploy Events are published by SCAYLE's storefront-hosting producer and delivered through the same webhook subscription scheme used by other SCAYLE webhooks, so there is no new infrastructure or delivery model to learn.
When to use Deploy Events
Use Deploy Events when you need any of your systems to react to deployment activity automatically. Common cases include:
- Post-deploy automation. Run smoke tests, cache warming, or health checks after
rollout-succeeded. - Team notifications. Post deployment status to Slack, Teams, or your incident channel on
deployment-started,deployment-succeeded, ordeployment-failed. - Incident correlation. Match
payload.idfrom events against thescayle.platform.deployment.idfield in Application Logs to see which deployment was live when something went wrong. - Rollback awareness. React to
rollback-startedorrollback-succeededand trigger your own recovery or communication workflows.
Event categories
Deploy Events publish 13 distinct events across four categories, covering the full deployment lifecycle:
| Category | Events |
|---|---|
| Deployment | deployment-started, deployment-succeeded, deployment-failed, deployment-cancelled |
| Build | build-started, build-succeeded, build-failed |
| Rollout | rollout-started, rollout-succeeded, rollout-failed |
| Rollback | rollback-started, rollback-succeeded, rollback-failed |
A deployment runs through Build, then Rollout. If Rollout fails, Rollback starts automatically. If Build fails, no rollout is attempted and no rollback follows. See Event Reference for the full list, when each event fires, and the payload schema.
How subscriptions work
Subscriptions to Deploy Events are managed through the Admin API under the storefront-hosting producer, following the same pattern as other SCAYLE webhook producers. Each subscription:
- Targets a single event type (for example,
deployment-succeeded). - Is scoped to a single shop key (via the
meta.shopKeytarget filter). - Specifies the delivery URL on your side that receives the event payload.
See Managing Subscriptions for how to create, list, and remove subscriptions.
