Deploy
One deploy, as the host reports it.
Properties
Section titled “Properties”author?
Section titled “author?”
optionalauthor?:string
Who started it.
branch?
Section titled “branch?”
optionalbranch?:string
The branch it was built from.
commit?
Section titled “commit?”
optionalcommit?:string
The commit’s message, first line.
createdAt
Section titled “createdAt”createdAt:
string
ISO 8601 times.
error?
Section titled “error?”
optionalerror?:string
Why it failed, one line: “Command “npm run build” exited with 1”.
id:
string
inspectUrl?
Section titled “inspectUrl?”
optionalinspectUrl?:string
The host’s page for it, with the build log.
liveUrl?
Section titled “liveUrl?”
optionalliveUrl?:string
Where people see it: the production domain, or the branch’s stable preview address.
production
Section titled “production”production:
boolean
Built for production (as opposed to a preview of a branch).
project
Section titled “project”project:
string
The project or site, by name: “web”.
readyAt?
Section titled “readyAt?”
optionalreadyAt?:string
optionalsha?:string
staged?
Section titled “staged?”
optionalstaged?:boolean
Built for production, but not live until promoted (after a rollback, or with automatic promotion off).
status
Section titled “status”status:
DeployStatus
optionalurl?:string
The deploy’s own address.