Skip to content

Domain.connect

POST /{namespace}/domains/connect

Connect attaches a hostname a Startup already holds and verifies ownership through DNS.

Noun
Domain
Mode
do
Event
Domain.connected

Inputs

InputTypeRequiredDescription
hostnamestringrequiredThe hostname to attach.
startupStartuprequiredThe Startup it serves.
tenantTenantThe Tenant it serves, when a Customer connects its own name.

Outputs

OutputTypeRequiredDescription
domainDomainrequiredThe connected Domain.

Effects

  • Emits Domain.connected.
  • Performed by the Integration Engineer.
  • Two-way: it runs at once, in the try, send and do modes.
  • Issues a certificate once the DNS record verifies.
  • Asks for a TXT ownership proof and a CNAME that delegates certificate validation; refuses to reach live without the CNAME.
  • Refuses a wildcard name for a Tenant, and past the Tenant’s name count follows its Entitlement’s atBound.
  • Registers the Domain with Stripe as a payment method domain on the Startup’s account.

Refuses when

CheckErrorFixThen call
The input does not match the schema of the operation.invalid-inputRead the schema of the operation, then send every required field with the right type.Domain.connect
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.Domain.connect
The record changed since it was read, so the write would overwrite a newer version.conflictRead the record again, then retry the write against its current state.Domain.connect
A wildcard name for a Tenant, and past the Tenant’s name count follows its Entitlement’s atBoundrefusedClear what the check names, then call it again.Domain.connect

When it waits

GateDefault
Decision classMedium: two-way, visible
Delay window1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
LimitThe call Limit of the Permission it runs under.
Over the LimitIt 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.