Skip to content
SDKProductSites and apps

App methods

Every App Verb as a typed SDK method, with its inputs, result, refusals and an example.

Reference for App.

App.publish

Publish releases an App to its Customers, so each Tenant runs its newest build. Verb page.

TypeScript
interface AppVerbs {
  publish(input: AppPublishInput, options?: SB.CallOptions): SB.Call<App>
}

Emits App.published.

Inputs

InputTypeRequiredDescription
appApprequiredThe App to release.

Returns

OutputTypeRequiredDescription
appApprequiredThe App, now released.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

TypeScript
import { $ } from 'startup-builder'

const app = await $.App.publish({ app: 'app_sAebuEW683' })