Skip to content

by Startups.Studio

Core grammar Tenant

Tenant.provision

POST /{namespace}/tenants/provision

Provision creates a Customer’s Tenant in a Startup’s App, holding that Customer’s records apart from every other.

Noun: Tenant
Mode: do
Event: Tenant.provisioned

You, to your agent

Provision the latest tenant with a customer.

curl -X POST https://api.sb/routewise.dev/tenants/provision \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customer":"customer_1"}'

import { $ } from 'startup-builder'

const tenant = await $.Tenant.provision({ customer: 'customer_1' })

npx startup-builder do Tenant.provision --json '{"customer":"customer_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Tenant.provision({ customer: 'customer_1' })"
  }
}

Inputs

Input	Type	Required	Description
`customer`	Customer	required	The Customer the Tenant serves.

Outputs

Output	Type	Required	Description
`tenant`	Tenant	required	The new Tenant.

Effects

Emits Tenant.provisioned.
Performed by the Integration Engineer.
Grants the Entitlements of the Customer’s accepted Offers inside the Tenant.

Refuses when

Check	Error	Fix	Then call
The operation is part of an Offer the caller has not accepted or paid for.	`payment-required`	Accept the Offer named in the response, then retry the call.	Offer.accept
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Tenant.provision
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Tenant.provision

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Tenant.pin

Previous Page

Tenant.requestSetup

Next Page