---
title: "Create embedded experience URL"
method: POST
path: "/integration/v1/embedded/session"
---

# Create embedded experience URL

`POST /integration/v1/embedded/session`

## Request

- Base URL: `https://api.everee.com`
- URL: `https://api.everee.com/integration/v1/embedded/session`
- Auth: API key in header `Authorization`

Creates a magic link for an embedded experience that can be started by opening the returned URL in a webview.

## Request body

- object
  - `workerId` string: Required for worker components if "externalWorkerId" is null
  - `externalWorkerId` string: Required for worker components if "workerId" is null
  - `eventHandlerName` string, required: see "Handling events" in the Embed Implementation guide
  - `experience` 'ONBOARDING' | 'PAYMENT_HISTORY' | 'TAX_DOCUMENTS' | 'HOME_ADDRESS' | 'PAYMENT_DEPOSIT' | 'WORKER_HOME' | 'PAY_CARD_SIGNUP' | 'COMPANY_CONTRACT' | 'FUNDING_BANK_ACCOUNT', required: The component to display. For Payroll Infrastructure, the relevant components are "COMPANY_CONTRACT" (during company onboarding) and "FUNDING_BANK_ACCOUNT" (after onboarding, coming soon). The company-level components don't take a worker, so omit "workerId" and "externalWorkerId" for them.
  - `experienceVersion` string: Optional. The version of the component to display. When omitted, the current version is used.
  - `experienceOptions` object: Options to customize the experience of specific components.
    - `accountSetupEnabled` boolean: Whether the "ONBOARDING" component should require setting up an Everee login account. When "false", no login account or password will be created, and the worker won't be able to sign into Everee outside your application. The "PAY_CARD_SIGNUP" component needs a login account, so leave this "true" for workers you plan to offer the pay card.
    - `brandingEnabled` boolean: Whether a logo appears at the bottom of each component view.
    - `onboardingBackButtonEnabled` boolean: Whether the "back" button is visible in the "ONBOARDING" component.
    - `showOnboardingBookendScreens` string: Whether to show the beginning "welcome" and ending "confirmation" screens.

## Response `201`

201

---

[API](https://skmtc.dev/everee/apis/everee-embed.md) - [All operations](https://skmtc.dev/everee/apis/everee-embed/llms.txt) - [OpenAPI document](https://skmtc.dev/everee/apis/everee-embed/revisions/7b4f6f4912d4?raw)