FormsClientOptions
Properties
Section titled “Properties”apiKey
Section titled “apiKey”apiKey:
string
An organization-scoped API key, created in Hub under Organizations → API Keys.
Server-side only. This key acts for the whole organization and is not scoped to one form.
Anything you ship to a browser is readable by every visitor, so fetch form definitions from
your own server or build step and pass the resulting object to the rendering components — which
never receive the key. That split is why @ebitex/forms-sdk/react is a separate entry point.
baseUrl?
Section titled “baseUrl?”
optionalbaseUrl?:string
Defaults to ebitex’s production API. Override for a self-hosted or local deployment.
fetch?
Section titled “fetch?”
optionalfetch?: (input,init?) =>Promise<Response>
Injectable for testing or for a runtime with a non-global fetch.
Parameters
Section titled “Parameters”RequestInfo | URL
RequestInit
Returns
Section titled “Returns”Promise<Response>
onSandbox?
Section titled “onSandbox?”
optionalonSandbox?: (mode) =>void
Called when the mode the API reports for this organization changes: development or cutover while it is a sandbox an agency is building for a client, null once it is an
ordinary organization. Read off any response, including a refusal.
Parameters
Section titled “Parameters”SandboxMode | null
Returns
Section titled “Returns”void