> ## Documentation Index
> Fetch the complete documentation index at: https://docs.os.default.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Pixel and Forms SDK: API reference
> Every configuration option, method, and event exposed by the Default Pixel and Forms SDK, with defaults and verified behavior.
Use this reference to find every option, method, return value, and scheduler event for the Default
Pixel (`index.js`) and Forms SDK (`sdk.js`).
Read [Understand the Pixel and Forms SDK](/pixel-sdk-integration-guide) first to learn how the two
scripts work together.
Everything on this page comes from the script's own source. We call out anything we could not confirm.
## Entry points
| | The Pixel | The Forms SDK |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| File | `index.js` | `sdk.js` |
| CDN URL | `https://pixel.default.com/index.js` | `https://pixel.default.com/sdk.js` |
| Global | `window.DefaultPixel` | `window.DefaultPixelSDK` |
| Programmatic API | `on()`, `scheduler.*`, and `submitForm()`, shared with the Forms SDK. It has no `init()` and no `recordFormInteraction()`. | The full set: `init`, `on`, `submitForm`, `recordFormInteraction`, `scheduler.*`. |
| Auto-initializes from | `window.__defaultPixel__.key`, `.schedulerOrigins`, and `.autoDisplayScheduler` | `window.__defaultPixel__` (all fields) |
Both scripts read scheduler configuration from the same block and post to one shared scheduler event
bus. `on()`, `scheduler.*`, and `submitForm()` therefore behave the same from either script.
See [Methods](#methods) below for exactly which methods live on which global.
```html theme={null}
```
## Configuration
### Shared configuration options
Set these options as `window.__defaultPixel__`, or pass them to `DefaultPixelSDK.init(options)` with
the same shape. The `init()` path is useful when the key is only known at runtime.
The SDK reads `window.__defaultPixel__` automatically on load. A later `init()` call updates the
configuration in place, but it does not re-run identity or session warmup.
The Pixel (`index.js`) has no `init()` to call, but it reads `key`, `schedulerOrigins`, and
`autoDisplayScheduler` directly off the same `window.__defaultPixel__` block. Only `endpoint` is
SDK-only.
| Option | Type | Required | Default | Notes |
| ---------------------------------------------- | ---------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `publicKey` (`key` in the global config block) | `string` | Yes | none | Your domain's pixel public key. Without it, `init()` logs a warning, does nothing, and sends no requests. |
| `endpoint` | `string` | No | Default's API endpoint | Override this only if Default tells you to point at a proxy. This option is SDK-only, and the Pixel cannot override its endpoint. |
| `schedulerOrigins` | `string[]` | No | The endpoint's own origin, plus the matching scheduler origin if the endpoint's hostname starts with `api.` | The origins that can post scheduler events, such as booked and closed, into the page. Both scripts read this option and silently drop events from any other origin. |
| `autoDisplayScheduler` | `boolean \| { target: string \| HTMLElement; loader?: boolean }` | No | `true` | Default behavior when `submitForm()` resolves to a scheduler URL. `true` shows the full-screen modal, and `false` shows nothing, so you read the URL yourself. `{ target, loader? }` mounts the calendar inline at a CSS selector or element, and `loader: true` also shows the branded loading indicator inside that container until the calendar loads. You can override this per call to `submitForm()`. For automatically detected forms, see the note below this table. |
```ts theme={null}
DefaultPixelSDK.init({
publicKey: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
autoDisplayScheduler: { target: "#meeting-section" },
});
```
The Pixel (`index.js`) has no equivalent `init()` call. It always uses Default's standard endpoint.
It does read `schedulerOrigins` and `autoDisplayScheduler` off `window.__defaultPixel__`. See the table
above.
Automatically detected forms, which involve no `submitForm()` call, read only the `{ target, loader }`
shape of `autoDisplayScheduler`. The `true` and `false` values do not apply there, because the calendar
always displays somewhere on a handoff.
When `target` is set for an automatically detected form, the loading indicator defaults to shown. Set
`loader: false` there to hide it.
This default is the opposite of `submitForm()`'s. See
[The scheduler experience](/pixel-sdk-integration-guide#the-scheduler-experience) in the guide for what
this means in practice.
## Methods
`on`, `submitForm`, and `scheduler.*` are on both `window.DefaultPixel` and `window.DefaultPixelSDK`.
`init` and `recordFormInteraction` are on `window.DefaultPixelSDK` only.
### init
`DefaultPixelSDK.init(options)`. This method exists only on `window.DefaultPixelSDK`, and the Pixel
(`index.js`) has no equivalent call.
Every call configures the SDK, and the first call also starts it. The start warms identity and session,
and attaches the email-blur listener that powers pre-enrichment.
The start also checks for a pending scheduler handoff left over from a same-page redirect. The method
returns nothing.
See [Shared configuration options](#shared-configuration-options) above for `options`.
The SDK also calls this automatically on script load if `window.__defaultPixel__.key` is present. Most
integrations never call it directly.
### on
`DefaultPixelSDK.on(eventType, handler)`.
Subscribes to a raw scheduler event. Returns an unsubscribe function.
```ts theme={null}
const off = DefaultPixelSDK.on("meeting_booked", (payload) => {
console.log("booked", payload);
});
// later: off();
```
`eventType` is one of the five values in [Scheduler events](#scheduler-events) below. Most integrations
use the typed helpers under `scheduler.*` instead.
The helpers are equivalent, but they save you from typing the event name as a string.
### submitForm
`DefaultPixelSDK.submitForm(options)`. You can also call it as `DefaultPixel.submitForm(options)` on
the Pixel bundle, but most integrations only need it via the SDK (see [Entry points](#entry-points)).
It submits a set of field values directly to a known Pixel form, without going through form detection.
It returns a promise, never throws on a failed request, and resolves with `success: false` instead.
| Option | Type | Required | Notes |
| ---------------------- | ---------------------------------------------------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `pixelFormId` | `string` (UUID) | One of `pixelFormId` or `formId` | The id Default assigned when the form was approved on the **Forms** tab. It must belong to the domain tied to your public key, or the request 404s. |
| `formId` | `string` | One of `pixelFormId` or `formId` | The HTML `id` of the form. Use it if you do not use `pixelFormId`. |
| `responses` | `Record` | Yes, at least one entry | The field values to submit. |
| `metadata` | `Record` | No | Free-form data passed through to the submission event. |
| `autoDisplayScheduler` | `boolean \| { target: string \| HTMLElement; loader?: boolean }` | No | Overrides the default set on `init()` for this call only. With `{ target, loader: true }`, the branded loading indicator shows inside that container until the calendar loads. Omit `loader` or set it to `false` for no indicator. See [The scheduler experience](/pixel-sdk-integration-guide#the-scheduler-experience). |
```ts theme={null}
const result = await DefaultPixelSDK.submitForm({
pixelFormId: "11111111-1111-4111-8111-111111111111",
responses: {
email: "jane@example.com",
first_name: "Jane",
plan: "growth",
marketing_opt_in: true,
},
metadata: { source: "pricing-page", variant: "B" },
});
```
The return value:
| Field | Type | Present when |
| ----------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `success` | `boolean` | Always |
| `status` | `number` | Always. It holds the HTTP status, and `0` means the request never reached Default |
| `scheduler` | `{ url: string }` | The workflow returned a scheduler handoff |
| `redirect` | `{ url: string }` | The workflow returned a redirect handoff. The browser navigates automatically the moment this happens, regardless of `autoDisplayScheduler`. You cannot suppress it, and this field is informational only |
| `workflow` | `{ executionStatus?, handoff?, error? }` | The submission reached Default |
| `error` | `string` | `success` is `false` |
When multiple `