Skip to main content
The on-purchase hook lets you run custom logic immediately after a customer completes a purchase. If a brand has a backend script named ef-on-purchase, it fires automatically — no extra configuration needed. The hook is fire-and-forget: it runs asynchronously and never blocks the purchase redirect. Errors are logged but do not affect the customer’s checkout experience.

​
Convention

Create a backend script at scripts/ef-on-purchase.js. The script must export a default function that receives a purchase context object: 
// scripts/ef-on-purchase.js
export default function onPurchase(purchase) {
  // purchase contains all the context you need
  console.log('Purchase by', purchase.email, 'for', purchase.product_code);
}

​
Purchase context object

The exported function receives a single object with the following fields:
FieldTypeDescription
emailstringCustomer email address
customer_namestringCustomer’s full name
order_idstringOrder reference ID
product_codestringProduct code that was purchased
product_namestringProduct display name
amountnumberPurchase amount
currencystringCurrency code (e.g. 'USD')
brand_idnumberBrand ID
quiz_visitor_idstringQuiz visitor ID from session (if available)

​
Available APIs

The on-purchase hook runs in a restricted sandbox. The following APIs are available:
  • cache.get, cache.set, cache.del, cache.has, cache.setIfAbsent, cache.increment
  • queue.push, queue.cancel
  • CRM functions: getCrmField, getCrmFields, setCrmField, setCrmFields, etc.
  • session.get (read-only)
  • console.log
  • import (other backend scripts)

​
Disabled APIs

These APIs are no-ops in the purchase hook to prevent interference with the purchase flow:
  • redirect()
  • response.json(), response.send(), response.status()
  • http.get(), http.post()

​
Example: Cancel abandon email on purchase

export default function onPurchase(purchase) {
  var visitorId = purchase.quiz_visitor_id;
  if (visitorId) {
    queue.cancel('abandon:' + visitorId);
  }
}

​
Example: Record purchase in CRM

export default function onPurchase(purchase) {
  if (purchase.email) {
    setCrmField({
      slug: 'quiz-leads',
      fieldKey: 'purchased_at',
      value: new Date().toISOString(),
      referenceType: 'customer_email',
      referenceId: purchase.email,
      force: true,
      async: true,
    });

    setCrmField({
      slug: 'quiz-leads',
      fieldKey: 'order_value',
      value: purchase.amount,
      referenceType: 'customer_email',
      referenceId: purchase.email,
      force: true,
      async: true,
    });
  }
}
The on-purchase hook is fire-and-forget. Errors are logged to the console but never block the purchase flow or redirect. Keep your hook logic fast — avoid long-running operations.