Created
RefRef bound a referral: attribution found a referrer for the referee of an Event or a Subscription, or you recorded the referral. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to referral.created, and retries for about 72 hours until the endpoint answers 2xx.
Header Parameters
The event ID. Every delivery of an event has the same one; deduplicate on it.
Unix seconds when RefRef signed the request. Refuse an old timestamp.
One v1, for each active secret, separated by spaces, of ... The key is the base64 text after whsec_ in the endpoint secret.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
RefRef bound a referral: attribution found a referrer for the referee of an Event or a Subscription, or you recorded the referral.
Response Body
Example Requests
RefRef bound a referral: attribution found a referrer for the referee of an Event or a Subscription, or you recorded the referral.
/referral.createdRecord Referral POST
Record a referral that you already know, for example from a support ticket or a sales call: the referee (by kind and your external ID; RefRef creates it when it does not know it), the referrer (by kind and external ID, or by its referral code, the only way to name a partner), and the Program. The referrer must be enrolled in the Program now. A referee that already has a referral is a conflict, and so is a referee with a purchase when the attribution policy accepts only new customers. The referral has no binding fact: Events that RefRef receives after it use it. A write applies at once. Needs the referrals:write key permission.
Voided Webhook
An operator voided a referral. Its Rewards are voided, and later Events of the referee get no referral. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to referral.voided, and retries for about 72 hours until the endpoint answers 2xx.