All Pixel Functions

The Northbeam Pixel adds these functions to window.Northbeam. The Northbeam Pixel must be on the page before you call any of them. Each one works the same way on Shopify and custom stores.

Function	What it does	Documented in
`fireSlimPurchaseEvent`	Records a completed order. Recommended.	Purchase Events
`firePurchaseEvent`	The original purchase function. Only its order ID is used	Purchase Events
`identify`	Links the visitor to their email address	Identify Events
`identifyCustomerId`	Links the visitor to their customer ID	Identify Events
`trackPageView`	Records a page change on single-page apps only	Page View Events
`fireCustomGoal`	Records a custom action, like a sign-up or add-to-cart	Custom Goals
`fireEmailCaptureEvent`	Records an email sign-up	Below
`onNorthbeamLoad`	Runs your code as soon as the pixel loads	Below

`fireEmailCaptureEvent`

Records that a visitor signed up with their email address, for example through a newsletter form.

window.Northbeam.fireEmailCaptureEvent("john.smith@gmail.com", "klaviyo_footer")

Argument		Type	Description
1	required	String	The email address
2		String	Where the email was captured (for example, `"klaviyo_footer"`)

You don’t need to call identify after fireEmailCaptureEvent. It identifies the visitor automatically.

Run code when the pixel loads (`onNorthbeamLoad`)

Use this to call a Northbeam function as soon as the pixel is ready. This helps if your code might run before the pixel has loaded.

<script type="text/javascript">
  const func = () => {
    // get args
    window.Northbeam.fireSlimPurchaseEvent(orderId)
  }

  if (window.Northbeam) {
    // Northbeam is already loaded, so call the function now
    func()
  } else {
    // Northbeam isn't loaded yet. Save the function in
    // window.onNorthbeamLoad, and the pixel will call it
    // as soon as window.Northbeam is ready.
    window.onNorthbeamLoad = func
  }
</script>

​fireEmailCaptureEvent

​Run code when the pixel loads (onNorthbeamLoad)

`fireEmailCaptureEvent`

Run code when the pixel loads (`onNorthbeamLoad`)