Affiliate events are triggered when changes occur to affiliate accounts in your program.
Events
| Event | Description |
|---|
affiliate.created | New affiliate signs up or is manually created |
affiliate.confirmed | Affiliate confirms their email address |
affiliate.updated | Affiliate details or status are updated |
affiliate.deleted | Affiliate is removed from the program |
Payload
Event type (e.g., affiliate.created)
ISO 8601 timestamp of when the event occurred
Event payload data.Show Data Object Properties
Unique identifier for the affiliate
The program this affiliate belongs to
The affiliate’s unique tracking/referral code
Current status: PENDING, ACTIVE, INACTIVE
Affiliate’s email address
Example Payloads
{
"id": "evt_abc123",
"type": "affiliate.created",
"createdAt": "2024-01-15T10:30:00.000Z",
"data": {
"affiliateId": "aff_xyz789",
"affiliateProgramId": "prog_abc123",
"trackingId": "john-doe",
"status": "PENDING",
"email": "[email protected]",
"name": "John Doe"
}
}
{
"id": "evt_abc123",
"type": "affiliate.confirmed",
"createdAt": "2024-01-15T10:30:00.000Z",
"data": {
"affiliateId": "aff_xyz789",
"affiliateProgramId": "prog_abc123",
"trackingId": "john-doe",
"status": "ACTIVE",
"email": "[email protected]",
"name": "John Doe"
}
}
{
"id": "evt_abc123",
"type": "affiliate.updated",
"createdAt": "2024-01-15T10:30:00.000Z",
"data": {
"affiliateId": "aff_xyz789",
"affiliateProgramId": "prog_abc123",
"trackingId": "john-doe",
"status": "ACTIVE",
"email": "[email protected]",
"name": "John Doe"
}
}
{
"id": "evt_abc123",
"type": "affiliate.deleted",
"createdAt": "2024-01-15T10:30:00.000Z",
"data": {
"affiliateId": "aff_xyz789",
"affiliateProgramId": "prog_abc123",
"trackingId": "john-doe",
"email": "[email protected]"
}
}
