Enrolled
A partner joined an affiliate Program: it accepted an invitation, or an operator approved its application. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to partner.enrolled, 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.
A partner joined an affiliate Program: it accepted an invitation, or an operator approved its application.
Response Body
Example Requests
A partner joined an affiliate Program: it accepted an invitation, or an operator approved its application.
/partner.enrolledBanned Webhook
An operator banned a partner from the Project. The ban ended its enrollments and declined its pending applications. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to partner.banned, and retries for about 72 hours until the endpoint answers 2xx.
Pause Program POST
Pause a live Program: no new referrals or enrollments, and links open the landing page without tracking. Earlier referrals keep earning Rewards. resume_program undoes it. A write applies at once. Needs the programs:write key permission.