Affiliate Events

Discover a comprehensive list of events that can activate webhooks, such as affiliate sign-ups, approvals, declines, and removals.

Events

Event	Description
`affiliate-signup`	Triggers whenever an affiliate joins one of your programs.
`affiliate-approved`	Triggers whenever an affiliate is approved to join an affiliate program that you operate.
`affiliate-declined`	Triggers whenever an affiliate is rejected from joining an affiliate program that you operate.
`affiliate-removed`	Triggers whenever an affiliate is removed.

Webhook Payload Examples

affiliate-approved

{
  "event_id": "whev_1kg84n28bokqx2r9",
  "event_type": "affiliate-approved",
  "api_version": 2,
  "object": "event",
  "data": {
    "affiliate": {
      "object": "affiliate",
      "email": "[email protected]",
      "name": "John",
      "surname": null,
      "address": "Super Street",
      "city": "Frankfurt",
      "state": null,
      "country": "de",
      "postcode": "ABC123",
      "vat": null,
      "telephone": "+49123456789",
      "id": "a5af6690-1622-4726-b201-f829df269d28",
      "affiliate_program_id": "9d1c6ac2-bf2c-403f-9261-96235d18e5be",
      "affiliate_program_label": "20% Commission",
      "currency": "EUR",
      "sales": 0,
      "referrals": 0,
      "balance": 0,
      "bonus": 0,
      "approved": true,
      "payments": null,
      "language": "en",
      "timezone": "Europe/Berlin",
      "timezone_offset": 3600
    }
  },
  "endpoint_id": "9ab698f5-99de-4ff6-8bfc-a7dcb973d177"
}

affiliate-declined

{
  "event_id": "whev_k8rrm122s7mjrx52",
  "event_type": "affiliate-declined",
  "api_version": 2,
  "object": "event",
  "data": {
    "affiliate": {
      "object": "affiliate",
      "email": "[email protected]",
      "name": "John",
      "surname": null,
      "address": "Super Street",
      "city": "Frankfurt",
      "state": null,
      "country": "de",
      "postcode": "ABC123",
      "vat": null,
      "telephone": "+49123456789",
      "id": "a5af6690-1622-4726-b201-f829df269d28",
      "affiliate_program_id": "9d1c6ac2-bf2c-403f-9261-96235d18e5be",
      "affiliate_program_label": "20% Commission",
      "currency": "EUR",
      "sales": 0,
      "referrals": 0,
      "balance": 0,
      "bonus": 0,
      "approved": false,
      "payments": null,
      "language": "en",
      "timezone": "Europe/Berlin",
      "timezone_offset": 3600
    }
  },
  "endpoint_id": "9ab698f5-99de-4ff6-8bfc-a7dcb973d177"
}

affiliate-removed

{
  "event_id": "whev_wq96jyg7nc3gz8kge",
  "event_type": "affiliate-removed",
  "api_version": 2,
  "object": "event",
  "data": {
    "affiliate": {
      "id": "a5af6690-1622-4726-b201-f829df269d28"
    }
  },
  "endpoint_id": "9ab698f5-99de-4ff6-8bfc-a7dcb973d177"
}

affiliate-signup

{
  "event_id": "whev_nr6ndxj9a2xrweeg",
  "event_type": "affiliate-signup",
  "api_version": 2,
  "object": "event",
  "data": {
    "affiliate": {
      "object": "affiliate",
      "email": "[email protected]",
      "name": "John",
      "surname": null,
      "address": "Super Street",
      "city": "Frankfurt",
      "state": null,
      "country": "de",
      "postcode": null,
      "vat": null,
      "telephone": "+49123456789",
      "id": "546784e5-024c-4b28-935f-004aaa32eda6",
      "affiliate_program_id": "9d1c6ac2-bf2c-403f-9261-96235d18e5be",
      "affiliate_program_label": "20% Commission",
      "currency": "EUR",
      "sales": 0,
      "referrals": 0,
      "balance": 0,
      "bonus": 0,
      "approved": false,
      "payments": null,
      "language": "en"
    }
  },
  "endpoint_id": "9ab698f5-99de-4ff6-8bfc-a7dcb973d177"
}