GrowthRailDocs

Webhook events

EventWhat it signalsGrowth Rail action
user.createdUser signup confirmed by provider.Record signup proof; join to pending SDK attribution claim.

How attribution works

A verified provider event proves the signup happened — but not that the user was referred. Growth Rail completes a referral only when that event joins to the opaque attribution claim previously captured by the SDK on the referring user's device.

Identity rule: Growth Rail joins events to claims using stable IDs and opaque tokens. It never correlates users by email, name, phone number, or billing address.
1

Create the Growth Rail connection

Open Dashboard → Integrations → Auth, choose WorkOS AuthKit, and create a Sandbox or Production connection. Copy the generated webhook endpoint URL — you will paste it into WorkOS AuthKit in the next step.

2

Register the webhook in WorkOS AuthKit

In WorkOS Dashboard → Webhooks, add the copied endpoint and subscribe to user.created.

Return to Growth Rail and save the WorkOS endpoint secret (whsec_…). Growth Rail encrypts and stores it — the raw value is never returned by the API after saving.

Security: Never commit webhook secrets to source control or log them. If a secret is compromised, rotate it in both WorkOS AuthKit and Growth Rail immediately.
3

Pass attribution data from your app

Pass the same WorkOS user ID returned by AuthKit and delivered as data.id in user.created.

ts
// Run after AuthKit resolves the authenticated user.
await GrowthRail.initAppUser(workosUser.id);
4

Verify end-to-end in test mode

Sign up through AuthKit, then confirm the user.created delivery is verified in both WorkOS and Growth Rail.

OutcomeMeaning
CompletedSignup proof and SDK attribution token matched. The referral reward has been triggered.
Awaiting attributionThe webhook signature was valid, but the SDK claim has not arrived yet — or the stable user ID did not match a pending claim. The event is held; Growth Rail completes the referral when the claim arrives.
IgnoredThe event was verified but no matching attribution claim exists and the hold window has expired, or the event type is out of scope.
Provider-specific notes
  • WorkOS webhook events can arrive out of sequence; Growth Rail deduplicates using the signed event ID.
  • Validate every enabled social and enterprise signup path in your own WorkOS staging environment.