Installation Checklist

Line up the right app key, identifiers, and launch path before you start wiring code.

Last reviewed

Installation Checklist

The point of installation is not to tick a setup box. It is to end with one real flow working in one real environment.

Do not try to solve every production concern up front. Get the first path working, then harden it.

Before you start

Before you write code, make sure you know:

  • which app configuration will own this integration
  • whether your first path is widget install, hosted embed, or direct API use
  • which environment you will test first
  • whether responses need to carry a known user identity on day one
  • whether JWT-based auth is required before launch

Install in the right order

1. Confirm the app you are integrating

You need the public app API key that scopes requests to your app.

  • Hosted embed needs the survey ID you want to load.
  • Widget installs usually need the flow ID you want to open.
  • Direct API submission needs the published flow version ID at submission time, or a survey ID that you resolve to the latest published version.

2. Pick the first delivery path

  • Use Install if you want the widget to open flows from your app.
  • Use Embed Surveys if you want a hosted survey in an iframe or link.
  • Use Reference if you plan to submit responses yourself.

3. Prove the path end to end

The goal here is not polish. The goal is proof:

  • the survey or flow loads
  • the request is scoped to the right app
  • one response submits successfully
  • you understand which identity and auth requirements apply

What teams usually add next

Once the first path works, teams usually tighten the integration in this order:

  1. identity parameters or identities payloads
  2. JWT auth and perimeter alignment
  3. theming and visual consistency
  4. consent and compliance controls

Next steps