Install Orwel in HTML

1. 1

   Load the SDK

   Nothing to install. Paste the script in the <head> of every page, before </head>.

   index.html

   <script src="https://cdn.jsdelivr.net/npm/orwel@1/dist/orwel.umd.js"></script>

2. 2

   Add your production API key

   The key goes straight into the script of step 3. It is public, not a secret. Signed out you see a placeholder. Sign in and your real key shows up here.

   production API key

   orwel_pk_TU_KEY

3. 3

   Init once on the client

   Paste it right after the script from step 1.

   index.html

   <script>orwel.init({ apiKey: 'orwel_pk_TU_KEY' })</script>

4. 4

   Capture your leads

   On submit of every form that captures a contact: identify the person and await the conversion before redirecting. If r.success is false, r.reason tells you why.

   contact form

   <script>
     const form = document.querySelector('form')
     form.addEventListener('submit', async (e) => {
       e.preventDefault()
       const data = Object.fromEntries(new FormData(form))
       orwel.identify({ email: data.email, name: data.name })
       const r = await orwel.conversion('contact_form')
       if (!r.success) console.warn('Orwel:', r.reason)
       form.submit()
     })
   </script>

5. 5

   Verify it live

   Use the dev key instead of the production one while you test. Those events are flagged as test and never count in your reports.

   Open your site with the dev key and watch every event arrive in Dev mode Open Dev mode