Docs

referral.created

A referred person signs up: reported by the tracking script or the API, accepted as a lead, or first seen paying with a partner’s code.

A referred person signs up: reported by the tracking script or the API, accepted as a lead, or first seen paying with a partner’s code.

Every event is POSTed as JSON to each endpoint subscribed to it, signed with the endpoint’s secret. See Webhooks for verifying the signature and for retries.

Example

{
  "created": 1793600000000,
  "data": {
    "created_at": 1793600000000,
    "customer_id": "cus_Q2x8NorthWind",
    "email": "maya@northwind.io",
    "first_paid_at": 1793603600000,
    "id": "ref_7d1a40b2",
    "object": "referral",
    "partner_id": "aff_3f9c2e81"
  },
  "id": "evt_8f3b2c1d9e4a4b6f8c2d1e0a9b8c7d6e",
  "program_id": "prg_northwind",
  "type": "referral.created"
}

Money is in minor units (4900 is $49.00) and times are milliseconds since the Unix epoch. Use id to skip an event you already handled: an event can arrive more than once, and out of order.