Skip to main content
POST
Publish a deployment
Publishes the app’s latest successful build. Apps are served at https://<subdomain>.zite.so (or a custom domain). The default subdomain is the app ID (publicIdentifier), so customSubdomain is null until you set one.
  • External apps are public.
  • Internal apps are open only to the organization members given access, who sign in with Zite.
Publishing requires a successful build. If the latest build is still building or failed, the call returns a 400 explaining why. Poll GET /apps/{appId} until buildStatus is success, or fix errors with check or logs and commit again.

Authorizations

Authorization
string
header
required

Enter your Zite API key. Format: Bearer <api_key>

Path Parameters

appId
string
required

The app ID.

Response

The live deployment

published
boolean
Example:

true

snapshotId
integer

The build snapshot that is now live.

commitSha
string | null

The commit the published build was made from.

accessMode
enum<string>
default:internal

internal apps are available to your organization; external apps deploy to a public subdomain.

Available options:
internal,
external
customSubdomain
string | null

The custom subdomain (the <subdomain> in <subdomain>.zite.so), if one is set. Null means the app is served at its app ID, https://<publicIdentifier>.zite.so.

Example:

"agent-console"

publicIdentifier
string
Example:

"a1b2c3d4e5"

workspaceId
string | null
Example:

"8bce4d1edc51710f"

workflowRunLimit
object | null

Set when your organization is over its monthly workflow run allowance. The publish still went through.

triggerReconcile
object

Whether the app's workflow triggers were registered: status is ok, partial, failed, or pending.

triggerErrors
object | null

Trigger, schedule, or webhook declarations the build dropped, keyed by workflow. The app is live without them.