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
string
Unique event identifier
string
Event type (e.g.,
affiliate.created)string
ISO 8601 timestamp of when the event occurred
object
Event payload data.
Show Data Object Properties
Show Data Object Properties
string
Unique identifier for the affiliate
string
The program this affiliate belongs to
string
The affiliate’s unique tracking/referral code
string
Current status:
PENDING, ACTIVE, INACTIVEstring
Affiliate’s email address
string | null
Affiliate’s display name
string | null
Customer’s external user ID for linking referral users
object | null
Custom key-value data stored with the affiliate
string | null
Affiliate’s group ID
Example Payloads
affiliate.created
{
"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": "john@example.com",
"name": "John Doe",
"externalUserId": "user_123",
"metadata": {
"plan": "pro",
"signup_source": "landing_page"
},
"groupId": "grp_abc123"
}
}
affiliate.confirmed
{
"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": "john@example.com",
"name": "John Doe",
"externalUserId": "user_123",
"metadata": {
"plan": "pro"
},
"groupId": "grp_abc123"
}
}
affiliate.updated
{
"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": "john@example.com",
"name": "John Doe",
"externalUserId": "user_456",
"metadata": {
"plan": "enterprise"
},
"groupId": "grp_abc123"
}
}
affiliate.deleted
{
"id": "evt_abc123",
"type": "affiliate.deleted",
"createdAt": "2024-01-15T10:30:00.000Z",
"data": {
"affiliateId": "aff_xyz789",
"affiliateProgramId": "prog_abc123",
"trackingId": "john-doe",
"email": "john@example.com",
"externalUserId": "user_123",
"metadata": {
"plan": "pro"
}
}
}