Referral quickstart: Rails

Referrals in a Rails app: the tag in your layout, the partner's code kept by your own server, every signup reported as a lead, and sales from your billing system.

Before you start

• A key with the Referral tracking preset (the single scope conversions:write), made under Settings, Developers. Keep it on your server as BOLTCLAW_API_KEY, never in a browser or an app.
• The program's id, on its Setup tab, as BOLTCLAW_PROGRAM_ID.

1. Put the tag on your site

Add the version 2 tag to every page, in your root layout or template. It keeps a partner's code from ?via=<code> in a first-party cookie on your own domain, bc_ref, for the program's cookie window, and gives you BoltClawReferral.code() in the browser.

<script src="https://boltclaw.ai/referrals/v2.js" defer data-payment-links="auto"></script>

data-payment-links="auto" is only for Stripe Payment Links and the Buy Button; data-welcome="auto" adds the friend's welcome. The tag makes no request at all unless the welcome is on and the visitor arrived with a code.

2. Keep the code from your server

# app/controllers/application_controller.rb
class ApplicationController < ActionController::Base
  before_action :keep_referral

  REFERRAL_CODE = /\A[a-z0-9]+(-[a-z0-9]+)*\z/

  private

  def keep_referral
    code = params[:via].to_s
    return unless code.length.between?(3, 40) && code.match?(REFERRAL_CODE)
    cookies[:bc_ref] = { value: code, expires: 30.days, same_site: :lax, secure: true, httponly: false }
  end
end

Use your program's cookie window for 30.days. For partner links that open straight on your site you may also report the visit with POST /v1/referrals/clicks (code, ip, user_agent, referrer).

Why set the cookie from your server. Safari deletes a cookie a script created once the visitor has gone 7 days of browsing without using your site, and keeps one only 24 hours on a page reached through a tracking link, so a code the tag keeps can be gone a week later. A cookie your OWN server sets in its response keeps its full lifetime, unless it comes through somebody else's host (a third-party CNAME or IP address), which Safari caps at 7 days (WebKit's published tracking prevention rules, read 2026-10-23). Setting bc_ref from your server, not HttpOnly, keeps the full window and the tag still reads it.

3. Report each signup as a lead

# app/services/referrals.rb
require "net/http"
require "json"

module Referrals
  def self.report(body)
    uri = URI("https://api.boltclaw.ai/v1/referrals/conversions")
    request = Net::HTTP::Post.new(uri, "Authorization" => "Bearer #{ENV.fetch("BOLTCLAW_API_KEY")}", "Content-Type" => "application/json")
    request.body = { program_id: ENV.fetch("BOLTCLAW_PROGRAM_ID") }.merge(body).to_json
    Net::HTTP.start(uri.host, uri.port, use_ssl: true, read_timeout: 10) { |http| http.request(request) }
  end
end

# after the user is created (for example in your registrations controller)
code = cookies[:bc_ref]
Referrals.report(event: "lead", event_id: "signup-#{user.id}", customer: { id: user.id.to_s }, referral: (code ? { code: code } : nil))

Run it in a background job if you prefer: the same event_id makes a retry harmless.

4. Record sales

Connect the billing system you take payments with on the Setup tab (see Connect your billing system), and pass the code to checkout as its guide shows: sales, renewals and refunds are then reported for you, and the setup status ticks them off. Not on one of the twelve? Report each sale from your server with event: "sale", your own event_id for the payment, the same customer.id as the signup, amount in minor units and currency.

5. Send a test sale

Press Send a test sale on the Setup tab: a click, a signup, a sale with two items and a partial refund go through your real rules as test data, credited to the program's test partner, never paid and never counted. To check your own wiring, send one of your own conversions with "test": true: it is test data too, and Clear test data deletes it all. The setup status's rows turn green only for live events.