How it works
- The Octanist pixel creates a browser session.
- The pixel injects a hidden session field into the form.
- The visitor submits the form to your backend.
- Your backend reads the hidden session ID and the form fields.
- Your backend sends the lead to
POST /api/leadswithsessionId. - Octanist links the lead to the existing pixel session, page views, click IDs, UTMs, and consent state.
Install the pixel
Install the Octanist pixel site-wide. If your backend sends the lead, removedata-forms="true" from the script so the browser does not also submit the same lead.
Read the session field
The pixel injects this hidden field into normal forms:sessionId.
Send the lead
Send the submitted form data to the Create Lead API from your backend:externalId when your backend has a stable customer-owned identifier, such as an order number, quotation number, application ID, opportunity ID, or CRM lead ID. It is optional, unique within your organization, and makes retries idempotent.
If sessionId is valid, Octanist links the new lead to the existing pixel session. If it is missing, Octanist can still create the lead, but the lead may lose the original session and attribution context.
See Create Lead for authentication, supported fields, and full request examples.
AJAX forms
If your form submits through same-origin AJAX, the pixel also adds this request header when possible:Duplicate prevention
Use one capture method per form:- Server-side form capture through your backend
- Browser-side pixel form detection through
data-forms="true" - WordPress server-side capture through the Octanist plugin
- GTM DataLayer lead sending
data-forms="true" on the pixel and add data-octa-ignore only to the forms your backend already sends: