Collect credentials securely via Kernel’s hosted page, then use the authenticated session in your automations. This is the recommended approach for most applications. Use the Hosted UI when:Documentation Index
Fetch the complete documentation index at: https://tbd-6fc993ce-hypeship-intro-create-control-observe.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
- You need users to provide their credentials
- You want the simplest integration with minimal code
- You want Kernel to handle 2FA and multi-step login flows
Getting started
1. Create a Connection
A Managed Auth Connection attaches an authenticated domain to a profile so you can use the auth connection in future browsers. You can attach multiple auth connections to the same profile — one per domain — to keep several sites authenticated at once.2. Start a Login Session
Start a Managed Auth Session to get the hosted login URL.3. Collect Credentials
Send the user to the hosted login page:- See the login page for the target website
- Enter their credentials
- Complete 2FA if needed
4. Poll for Completion
On your backend, poll until authentication completes:Poll every 2 seconds. The session expires after 20 minutes if not completed, and the flow times out after 10 minutes of waiting for user input.
5. Use the Profile
Create browsers with the profile and navigate to the site. The browser session will already be authenticated:Managed Auth Connections are generated using Kernel’s stealth mode. Use
stealth: true when creating authenticated browser sessions for the best experience.Complete Example
Success / error redirects
To redirect the user back to your app once the flow finishes — for example, to auto-close the auth window inside a mobile in-app browser — appendsuccess_url and/or error_url query params to hosted_url. These mirror the onSuccess / onError callbacks exposed by the React Component.
success_url— visited when the session reachesSUCCESS. The hosted page appendsprofile_nameanddomainas query params.error_url— visited when the session reachesFAILED,CANCELED, orEXPIRED. The hosted page appendscode(when present) andmessageas query params.
myapp://auth/done) to bounce back into the host app.