Affiliate webhook events

Events

• affiliate.created – Affiliate joins your program (or is created by you).
• affiliate.confirmed – Affiliate confirmed (e.g., onboarding completed).
• affiliate.updated – Affiliate details or status change.
• affiliate.deleted – Affiliate is removed.

Payload example

{
  "id": "evt_123",
  "type": "affiliate.created",
  "timestamp": "2025-01-09T10:00:00.000Z",
  "version": 1,
  "data": {
    "affiliateId": "aff_123",
    "email": "jane@example.com",
    "accountStatus": "ACTIVE",
    "affiliateProgramId": "prog_123",
    "partnershipStatus": "APPROVED",
    "trackingId": "TRK123",
    "source": "INVITE",
    "groupId": "grp_123",
    "onboardingCompleted": true,
    "country": "DE",
    "promoCodes": [
      {
        "code": "WELCOME10",
        "promoCodeId": "pc_123",
        "couponId": "cp_123",
        "discountType": "percent",
        "duration": "once",
        "discountValue": "10.00",
        "createdAt": "2025-01-08T10:00:00.000Z"
      }
    ],
    "createdAt": "2025-01-09T10:00:00.000Z",
    "updatedAt": "2025-01-09T10:00:00.000Z"
  },
  "attempt": 1,
  "webhook_id": "whd_123",
  "endpoint_id": "whe_123"
}

Field reference (data)

• affiliateId (string): Affiliate user id.
• email (string)
• affiliateProgramId (string)
• trackingId (string | null)
• source (string | null): e.g., INVITE, MARKETPLACE, DIRECT.
• groupId (string | null): ID of the affiliate group to which this affiliate user is currently assigned.
• onboardingCompleted (boolean)
• accountStatus (string enum): e.g., PENDING, ACTIVE, REJECTED.
• partnershipStatus (string enum): PENDING, APPROVED, REJECTED.
• country (string | null): ISO country if available.
• promoCodes (array):
  • code (string)
  • promoCodeId (string | null)
  • couponId (string | null)
  • discountType (string | null)
  • duration (string | null)
  • discountValue (string | null/number)
  • createdAt (ISO datetime)
• createdAt (ISO datetime): Affiliate created time.
• updatedAt (ISO datetime): Last update time.

Meta fields:

• attempt (number): current delivery attempt.
• webhook_id (string): delivery id for logging/replay.
• endpoint_id (string): target endpoint id.